diff --git a/cloudstack/APIDiscoveryService.go b/cloudstack/APIDiscoveryService.go index a70f1cd..f6fc3e5 100644 --- a/cloudstack/APIDiscoveryService.go +++ b/cloudstack/APIDiscoveryService.go @@ -73,7 +73,7 @@ func (s *APIDiscoveryService) NewListApisParams() *ListApisParams { return p } -// lists all available apis on the server, provided by the Api Discovery plugin +// Lists all available APIs on the server, provided by the API Discovery plugin func (s *APIDiscoveryService) ListApis(p *ListApisParams) (*ListApisResponse, error) { resp, err := s.cs.newRequest("listApis", p.toURLValues()) if err != nil { diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index be33678..5170559 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -594,7 +594,7 @@ func (s *AccountService) NewDeleteAccountParams(id string) *DeleteAccountParams return p } -// Deletes a account, and all users associated with this account +// Deletes an Account and all Users associated with this Account func (s *AccountService) DeleteAccount(p *DeleteAccountParams) (*DeleteAccountResponse, error) { resp, err := s.cs.newPostRequest("deleteAccount", p.toURLValues()) if err != nil { @@ -1367,7 +1367,7 @@ func (s *AccountService) NewLinkAccountToLdapParams(account string, domainid str return p } -// link a cloudstack account to a group or OU in ldap +// Link a cloudstack account to a group or OU in ldap func (s *AccountService) LinkAccountToLdap(p *LinkAccountToLdapParams) (*LinkAccountToLdapResponse, error) { resp, err := s.cs.newPostRequest("linkAccountToLdap", p.toURLValues()) if err != nil { @@ -1864,7 +1864,7 @@ func (s *AccountService) GetAccountByID(id string, opts ...OptionFunc) (*Account return nil, l.Count, fmt.Errorf("There is more then one result for Account UUID: %s!", id) } -// Lists accounts and provides detailed account information for listed accounts +// Lists Accounts and provides detailed Account information for listed Accounts func (s *AccountService) ListAccounts(p *ListAccountsParams) (*ListAccountsResponse, error) { resp, err := s.cs.newRequest("listAccounts", p.toURLValues()) if err != nil { @@ -2245,7 +2245,7 @@ func (s *AccountService) GetProjectAccountID(keyword string, projectid string, o return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// Lists project's accounts +// Lists project's Accounts func (s *AccountService) ListProjectAccounts(p *ListProjectAccountsParams) (*ListProjectAccountsResponse, error) { resp, err := s.cs.newRequest("listProjectAccounts", p.toURLValues()) if err != nil { @@ -2416,7 +2416,7 @@ func (s *AccountService) NewLockAccountParams(account string, domainid string) * return p } -// This deprecated function used to locks an account. Look for the API DisableAccount instead +// This deprecated function used to lock an Account. Look for the API DisableAccount instead func (s *AccountService) LockAccount(p *LockAccountParams) (*LockAccountResponse, error) { resp, err := s.cs.newPostRequest("lockAccount", p.toURLValues()) if err != nil { @@ -2994,7 +2994,7 @@ func (s *AccountService) NewUpdateAccountParams() *UpdateAccountParams { return p } -// Updates account information for the authenticated user +// Updates Account information for the authenticated user func (s *AccountService) UpdateAccount(p *UpdateAccountParams) (*UpdateAccountResponse, error) { resp, err := s.cs.newPostRequest("updateAccount", p.toURLValues()) if err != nil { diff --git a/cloudstack/AddressService.go b/cloudstack/AddressService.go index 98ce3aa..0d146c4 100644 --- a/cloudstack/AddressService.go +++ b/cloudstack/AddressService.go @@ -406,7 +406,7 @@ func (s *AddressService) NewAssociateIpAddressParams() *AssociateIpAddressParams return p } -// Acquires and associates a public IP to an account. +// Acquires and associates a public IP to an Account. func (s *AddressService) AssociateIpAddress(p *AssociateIpAddressParams) (*AssociateIpAddressResponse, error) { resp, err := s.cs.newPostRequest("associateIpAddress", p.toURLValues()) if err != nil { @@ -553,7 +553,7 @@ func (s *AddressService) NewDisassociateIpAddressParams(id string) *Disassociate return p } -// Disassociates an IP address from the account. +// Disassociates an IP address from the Account. func (s *AddressService) DisassociateIpAddress(p *DisassociateIpAddressParams) (*DisassociateIpAddressResponse, error) { resp, err := s.cs.newPostRequest("disassociateIpAddress", p.toURLValues()) if err != nil { @@ -1308,7 +1308,7 @@ func (s *AddressService) GetPublicIpAddressByID(id string, opts ...OptionFunc) ( return nil, l.Count, fmt.Errorf("There is more then one result for PublicIpAddress UUID: %s!", id) } -// Lists all public ip addresses +// Lists all public IP addresses func (s *AddressService) ListPublicIpAddresses(p *ListPublicIpAddressesParams) (*ListPublicIpAddressesResponse, error) { resp, err := s.cs.newRequest("listPublicIpAddresses", p.toURLValues()) if err != nil { @@ -1588,7 +1588,7 @@ func (s *AddressService) NewReleaseIpAddressParams(id string) *ReleaseIpAddressP return p } -// Releases an IP address from the account. +// Releases an IP address from the Account. func (s *AddressService) ReleaseIpAddress(p *ReleaseIpAddressParams) (*ReleaseIpAddressResponse, error) { resp, err := s.cs.newPostRequest("releaseIpAddress", p.toURLValues()) if err != nil { @@ -1874,7 +1874,7 @@ func (s *AddressService) NewReserveIpAddressParams(id string) *ReserveIpAddressP return p } -// Reserve a public IP to an account. +// Reserve a public IP to an Account. func (s *AddressService) ReserveIpAddress(p *ReserveIpAddressParams) (*ReserveIpAddressResponse, error) { resp, err := s.cs.newPostRequest("reserveIpAddress", p.toURLValues()) if err != nil { diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index afd1767..f202a81 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -1093,7 +1093,7 @@ func (s *AffinityGroupService) NewUpdateVMAffinityGroupParams(id string) *Update return p } -// Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. +// Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect. func (s *AffinityGroupService) UpdateVMAffinityGroup(p *UpdateVMAffinityGroupParams) (*UpdateVMAffinityGroupResponse, error) { resp, err := s.cs.newPostRequest("updateVMAffinityGroup", p.toURLValues()) if err != nil { @@ -1131,6 +1131,7 @@ func (s *AffinityGroupService) UpdateVMAffinityGroup(p *UpdateVMAffinityGroupPar type UpdateVMAffinityGroupResponse struct { Account string `json:"account"` Affinitygroup []UpdateVMAffinityGroupResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` diff --git a/cloudstack/AnnotationService.go b/cloudstack/AnnotationService.go index 584883e..499c943 100644 --- a/cloudstack/AnnotationService.go +++ b/cloudstack/AnnotationService.go @@ -156,7 +156,7 @@ func (s *AnnotationService) NewAddAnnotationParams() *AddAnnotationParams { return p } -// add an annotation. +// Add an annotation. func (s *AnnotationService) AddAnnotation(p *AddAnnotationParams) (*AddAnnotationResponse, error) { resp, err := s.cs.newPostRequest("addAnnotation", p.toURLValues()) if err != nil { @@ -517,7 +517,7 @@ func (s *AnnotationService) NewRemoveAnnotationParams(id string) *RemoveAnnotati return p } -// remove an annotation. +// Remove an annotation. func (s *AnnotationService) RemoveAnnotation(p *RemoveAnnotationParams) (*RemoveAnnotationResponse, error) { resp, err := s.cs.newPostRequest("removeAnnotation", p.toURLValues()) if err != nil { @@ -622,7 +622,7 @@ func (s *AnnotationService) NewUpdateAnnotationVisibilityParams(adminsonly bool, return p } -// update an annotation visibility. +// Update an annotation visibility. func (s *AnnotationService) UpdateAnnotationVisibility(p *UpdateAnnotationVisibilityParams) (*UpdateAnnotationVisibilityResponse, error) { resp, err := s.cs.newPostRequest("updateAnnotationVisibility", p.toURLValues()) if err != nil { diff --git a/cloudstack/AsyncjobService.go b/cloudstack/AsyncjobService.go index fe29bc4..aedb541 100644 --- a/cloudstack/AsyncjobService.go +++ b/cloudstack/AsyncjobService.go @@ -70,6 +70,12 @@ func (p *ListAsyncJobsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + 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)) } @@ -244,6 +250,48 @@ func (p *ListAsyncJobsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListAsyncJobsParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *ListAsyncJobsParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *ListAsyncJobsParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *ListAsyncJobsParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *ListAsyncJobsParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *ListAsyncJobsParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + func (p *ListAsyncJobsParams) SetStartdate(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -273,7 +321,7 @@ func (s *AsyncjobService) NewListAsyncJobsParams() *ListAsyncJobsParams { return p } -// Lists all pending asynchronous jobs for the account. +// Lists all pending asynchronous jobs for the Account. func (s *AsyncjobService) ListAsyncJobs(p *ListAsyncJobsParams) (*ListAsyncJobsResponse, error) { resp, err := s.cs.newRequest("listAsyncJobs", p.toURLValues()) if err != nil { @@ -326,6 +374,12 @@ func (p *QueryAsyncJobResultParams) toURLValues() url.Values { if v, found := p.p["jobid"]; found { u.Set("jobid", 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)) + } return u } @@ -350,6 +404,48 @@ func (p *QueryAsyncJobResultParams) GetJobID() (string, bool) { return value, ok } +func (p *QueryAsyncJobResultParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *QueryAsyncJobResultParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *QueryAsyncJobResultParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *QueryAsyncJobResultParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *QueryAsyncJobResultParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *QueryAsyncJobResultParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + // You should always use this function to get a new QueryAsyncJobResultParams instance, // as then you are sure you have configured all required params func (s *AsyncjobService) NewQueryAsyncJobResultParams(jobid string) *QueryAsyncJobResultParams { diff --git a/cloudstack/AutoScaleService.go b/cloudstack/AutoScaleService.go index 58aab95..ad16566 100644 --- a/cloudstack/AutoScaleService.go +++ b/cloudstack/AutoScaleService.go @@ -229,7 +229,7 @@ func (s *AutoScaleService) NewCreateAutoScalePolicyParams(action string, conditi return p } -// Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. +// Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale Instance group. func (s *AutoScaleService) CreateAutoScalePolicy(p *CreateAutoScalePolicyParams) (*CreateAutoScalePolicyResponse, error) { resp, err := s.cs.newPostRequest("createAutoScalePolicy", p.toURLValues()) if err != nil { @@ -529,7 +529,7 @@ func (s *AutoScaleService) NewCreateAutoScaleVmGroupParams(lbruleid string, maxm return p } -// Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. +// Creates and automatically starts an Instance based on a service offering, disk offering, and Template. func (s *AutoScaleService) CreateAutoScaleVmGroup(p *CreateAutoScaleVmGroupParams) (*CreateAutoScaleVmGroupResponse, error) { resp, err := s.cs.newPostRequest("createAutoScaleVmGroup", p.toURLValues()) if err != nil { @@ -968,7 +968,7 @@ func (s *AutoScaleService) NewCreateAutoScaleVmProfileParams(serviceofferingid s return p } -// Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. +// Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature. func (s *AutoScaleService) CreateAutoScaleVmProfile(p *CreateAutoScaleVmProfileParams) (*CreateAutoScaleVmProfileResponse, error) { resp, err := s.cs.newPostRequest("createAutoScaleVmProfile", p.toURLValues()) if err != nil { @@ -1195,7 +1195,7 @@ func (s *AutoScaleService) NewCreateConditionParams(counterid string, relational return p } -// Creates a condition for VM auto scaling +// Creates a condition for Instance auto scaling func (s *AutoScaleService) CreateCondition(p *CreateConditionParams) (*CreateConditionResponse, error) { resp, err := s.cs.newPostRequest("createCondition", p.toURLValues()) if err != nil { @@ -1368,7 +1368,7 @@ func (s *AutoScaleService) NewCreateCounterParams(name string, provider string, return p } -// Adds metric counter for VM auto scaling +// Adds metric counter for Instance auto scaling func (s *AutoScaleService) CreateCounter(p *CreateCounterParams) (*CreateCounterResponse, error) { resp, err := s.cs.newPostRequest("createCounter", p.toURLValues()) if err != nil { @@ -1566,7 +1566,7 @@ func (s *AutoScaleService) NewDeleteAutoScaleVmGroupParams(id string) *DeleteAut return p } -// Deletes a autoscale vm group. +// Deletes an autoscale Instance group. func (s *AutoScaleService) DeleteAutoScaleVmGroup(p *DeleteAutoScaleVmGroupParams) (*DeleteAutoScaleVmGroupResponse, error) { resp, err := s.cs.newPostRequest("deleteAutoScaleVmGroup", p.toURLValues()) if err != nil { @@ -1648,7 +1648,7 @@ func (s *AutoScaleService) NewDeleteAutoScaleVmProfileParams(id string) *DeleteA return p } -// Deletes a autoscale vm profile. +// Deletes a autoscale Instance profile. func (s *AutoScaleService) DeleteAutoScaleVmProfile(p *DeleteAutoScaleVmProfileParams) (*DeleteAutoScaleVmProfileResponse, error) { resp, err := s.cs.newPostRequest("deleteAutoScaleVmProfile", p.toURLValues()) if err != nil { @@ -1730,7 +1730,7 @@ func (s *AutoScaleService) NewDeleteConditionParams(id string) *DeleteConditionP return p } -// Removes a condition for VM auto scaling +// Removes a condition for Instance auto scaling func (s *AutoScaleService) DeleteCondition(p *DeleteConditionParams) (*DeleteConditionResponse, error) { resp, err := s.cs.newPostRequest("deleteCondition", p.toURLValues()) if err != nil { @@ -1812,7 +1812,7 @@ func (s *AutoScaleService) NewDeleteCounterParams(id string) *DeleteCounterParam return p } -// Deletes a counter for VM auto scaling +// Deletes a counter for Instance auto scaling func (s *AutoScaleService) DeleteCounter(p *DeleteCounterParams) (*DeleteCounterResponse, error) { resp, err := s.cs.newPostRequest("deleteCounter", p.toURLValues()) if err != nil { @@ -1894,7 +1894,7 @@ func (s *AutoScaleService) NewDisableAutoScaleVmGroupParams(id string) *DisableA return p } -// Disables an AutoScale Vm Group +// Disables an AutoScale Instance Group func (s *AutoScaleService) DisableAutoScaleVmGroup(p *DisableAutoScaleVmGroupParams) (*DisableAutoScaleVmGroupResponse, error) { resp, err := s.cs.newPostRequest("disableAutoScaleVmGroup", p.toURLValues()) if err != nil { @@ -2006,7 +2006,7 @@ func (s *AutoScaleService) NewEnableAutoScaleVmGroupParams(id string) *EnableAut return p } -// Enables an AutoScale Vm Group +// Enables an AutoScale Instance Group func (s *AutoScaleService) EnableAutoScaleVmGroup(p *EnableAutoScaleVmGroupParams) (*EnableAutoScaleVmGroupResponse, error) { resp, err := s.cs.newPostRequest("enableAutoScaleVmGroup", p.toURLValues()) if err != nil { @@ -2997,7 +2997,7 @@ func (s *AutoScaleService) GetAutoScaleVmGroupByID(id string, opts ...OptionFunc return nil, l.Count, fmt.Errorf("There is more then one result for AutoScaleVmGroup UUID: %s!", id) } -// Lists autoscale vm groups. +// Lists autoscale Instance groups. func (s *AutoScaleService) ListAutoScaleVmGroups(p *ListAutoScaleVmGroupsParams) (*ListAutoScaleVmGroupsResponse, error) { resp, err := s.cs.newRequest("listAutoScaleVmGroups", p.toURLValues()) if err != nil { @@ -3443,7 +3443,7 @@ func (s *AutoScaleService) GetAutoScaleVmProfileByID(id string, opts ...OptionFu return nil, l.Count, fmt.Errorf("There is more then one result for AutoScaleVmProfile UUID: %s!", id) } -// Lists autoscale vm profiles. +// Lists autoscale Instance profiles. func (s *AutoScaleService) ListAutoScaleVmProfiles(p *ListAutoScaleVmProfilesParams) (*ListAutoScaleVmProfilesResponse, error) { resp, err := s.cs.newRequest("listAutoScaleVmProfiles", p.toURLValues()) if err != nil { @@ -3808,7 +3808,7 @@ func (s *AutoScaleService) GetConditionByID(id string, opts ...OptionFunc) (*Con return nil, l.Count, fmt.Errorf("There is more then one result for Condition UUID: %s!", id) } -// List Conditions for VM auto scaling +// List Conditions for Instance auto scaling func (s *AutoScaleService) ListConditions(p *ListConditionsParams) (*ListConditionsResponse, error) { resp, err := s.cs.newRequest("listConditions", p.toURLValues()) if err != nil { @@ -4119,7 +4119,7 @@ func (s *AutoScaleService) GetCounterByID(id string, opts ...OptionFunc) (*Count return nil, l.Count, fmt.Errorf("There is more then one result for Counter UUID: %s!", id) } -// List the counters for VM auto scaling +// List the counters for Instance auto scaling func (s *AutoScaleService) ListCounters(p *ListCountersParams) (*ListCountersResponse, error) { resp, err := s.cs.newRequest("listCounters", p.toURLValues()) if err != nil { @@ -4589,7 +4589,7 @@ func (s *AutoScaleService) NewUpdateAutoScaleVmGroupParams(id string) *UpdateAut return p } -// Updates an existing autoscale vm group. +// Updates an existing autoscale Instance group. func (s *AutoScaleService) UpdateAutoScaleVmGroup(p *UpdateAutoScaleVmGroupParams) (*UpdateAutoScaleVmGroupResponse, error) { resp, err := s.cs.newPostRequest("updateAutoScaleVmGroup", p.toURLValues()) if err != nil { @@ -4978,7 +4978,7 @@ func (s *AutoScaleService) NewUpdateAutoScaleVmProfileParams(id string) *UpdateA return p } -// Updates an existing autoscale vm profile. +// Updates an existing autoscale Instance profile. func (s *AutoScaleService) UpdateAutoScaleVmProfile(p *UpdateAutoScaleVmProfileParams) (*UpdateAutoScaleVmProfileResponse, error) { resp, err := s.cs.newPostRequest("updateAutoScaleVmProfile", p.toURLValues()) if err != nil { @@ -5133,7 +5133,7 @@ func (s *AutoScaleService) NewUpdateConditionParams(id string, relationaloperato return p } -// Updates a condition for VM auto scaling +// Updates a condition for Instance auto scaling func (s *AutoScaleService) UpdateCondition(p *UpdateConditionParams) (*UpdateConditionResponse, error) { resp, err := s.cs.newPostRequest("updateCondition", p.toURLValues()) if err != nil { diff --git a/cloudstack/BackupService.go b/cloudstack/BackupService.go index 92033d8..ee7e50a 100644 --- a/cloudstack/BackupService.go +++ b/cloudstack/BackupService.go @@ -320,6 +320,7 @@ type AddBackupRepositoryResponse struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Mountopts string `json:"mountopts"` Name string `json:"name"` Provider string `json:"provider"` Type string `json:"type"` @@ -445,7 +446,7 @@ func (s *BackupService) NewCreateBackupParams(virtualmachineid string) *CreateBa return p } -// Create VM backup +// Create Instance backup func (s *BackupService) CreateBackup(p *CreateBackupParams) (*CreateBackupResponse, error) { resp, err := s.cs.newPostRequest("createBackup", p.toURLValues()) if err != nil { @@ -652,7 +653,7 @@ func (s *BackupService) NewCreateBackupScheduleParams(intervaltype string, sched return p } -// Creates a user-defined VM backup schedule +// Creates a User-defined Instance backup schedule func (s *BackupService) CreateBackupSchedule(p *CreateBackupScheduleParams) (*CreateBackupScheduleResponse, error) { resp, err := s.cs.newPostRequest("createBackupSchedule", p.toURLValues()) if err != nil { @@ -668,32 +669,16 @@ func (s *BackupService) CreateBackupSchedule(p *CreateBackupScheduleParams) (*Cr } type CreateBackupScheduleResponse struct { - Account string `json:"account"` - Accountid string `json:"accountid"` - Backupofferingid string `json:"backupofferingid"` - Backupofferingname string `json:"backupofferingname"` - Created string `json:"created"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externalid string `json:"externalid"` - Id string `json:"id"` - Intervaltype string `json:"intervaltype"` - Isbackupvmexpunged bool `json:"isbackupvmexpunged"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Size int64 `json:"size"` - Status string `json:"status"` - Type string `json:"type"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualmachinename string `json:"virtualmachinename"` - Virtualsize int64 `json:"virtualsize"` - Vmbackupofferingremoved bool `json:"vmbackupofferingremoved"` - Vmdetails map[string]string `json:"vmdetails"` - Volumes string `json:"volumes"` - Zone string `json:"zone"` - Zoneid string `json:"zoneid"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxbackups int `json:"maxbackups"` + Quiescevm bool `json:"quiescevm"` + Schedule string `json:"schedule"` + Timezone string `json:"timezone"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` } type CreateVMFromBackupParams struct { @@ -2200,6 +2185,7 @@ func (s *BackupService) CreateVMFromBackup(p *CreateVMFromBackupParams) (*Create type CreateVMFromBackupResponse struct { Account string `json:"account"` Affinitygroup []CreateVMFromBackupResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -2448,7 +2434,7 @@ func (s *BackupService) NewDeleteBackupParams(id string) *DeleteBackupParams { return p } -// Delete VM backup +// Delete Instance backup func (s *BackupService) DeleteBackup(p *DeleteBackupParams) (*DeleteBackupResponse, error) { resp, err := s.cs.newPostRequest("deleteBackup", p.toURLValues()) if err != nil { @@ -2741,7 +2727,7 @@ func (s *BackupService) NewDeleteBackupScheduleParams() *DeleteBackupSchedulePar return p } -// Deletes the backup schedule of a VM +// Deletes the backup schedule of a Instance func (s *BackupService) DeleteBackupSchedule(p *DeleteBackupScheduleParams) (*DeleteBackupScheduleResponse, error) { resp, err := s.cs.newPostRequest("deleteBackupSchedule", p.toURLValues()) if err != nil { @@ -3809,6 +3795,7 @@ type BackupRepository struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Mountopts string `json:"mountopts"` Name string `json:"name"` Provider string `json:"provider"` Type string `json:"type"` @@ -4113,7 +4100,7 @@ func (s *BackupService) GetBackupScheduleByID(id string, opts ...OptionFunc) (*B return nil, l.Count, fmt.Errorf("There is more then one result for BackupSchedule UUID: %s!", id) } -// List backup schedule of a VM +// List backup schedule of an Instance func (s *BackupService) ListBackupSchedule(p *ListBackupScheduleParams) (*ListBackupScheduleResponse, error) { resp, err := s.cs.newRequest("listBackupSchedule", p.toURLValues()) if err != nil { @@ -4590,7 +4577,7 @@ func (s *BackupService) GetBackupByID(id string, opts ...OptionFunc) (*Backup, i return nil, l.Count, fmt.Errorf("There is more then one result for Backup UUID: %s!", id) } -// Lists VM backups +// Lists Instance backups func (s *BackupService) ListBackups(p *ListBackupsParams) (*ListBackupsResponse, error) { resp, err := s.cs.newRequest("listBackups", p.toURLValues()) if err != nil { @@ -4684,7 +4671,7 @@ func (s *BackupService) NewRestoreBackupParams(id string) *RestoreBackupParams { return p } -// Restores an existing stopped or deleted VM using a VM backup +// Restores an existing stopped or deleted Instance using an Instance backup func (s *BackupService) RestoreBackup(p *RestoreBackupParams) (*RestoreBackupResponse, error) { resp, err := s.cs.newPostRequest("restoreBackup", p.toURLValues()) if err != nil { @@ -4886,6 +4873,7 @@ type UpdateBackupRepositoryResponse struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Mountopts string `json:"mountopts"` Name string `json:"name"` Provider string `json:"provider"` Type string `json:"type"` @@ -5211,7 +5199,7 @@ func (s *BackupService) NewUpdateBackupScheduleParams(intervaltype string, sched return p } -// Updates a user-defined VM backup schedule +// Updates a User-defined Instance backup schedule func (s *BackupService) UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) { resp, err := s.cs.newPostRequest("updateBackupSchedule", p.toURLValues()) if err != nil { diff --git a/cloudstack/BaremetalService.go b/cloudstack/BaremetalService.go index 9342506..6cd52f2 100644 --- a/cloudstack/BaremetalService.go +++ b/cloudstack/BaremetalService.go @@ -191,7 +191,7 @@ func (s *BaremetalService) NewAddBaremetalDhcpParams(dhcpservertype string, pass return p } -// adds a baremetal dhcp server +// Adds a baremetal DHCP server func (s *BaremetalService) AddBaremetalDhcp(p *AddBaremetalDhcpParams) (*AddBaremetalDhcpResponse, error) { resp, err := s.cs.newPostRequest("addBaremetalDhcp", p.toURLValues()) if err != nil { @@ -430,7 +430,7 @@ func (s *BaremetalService) NewAddBaremetalPxeKickStartServerParams(password stri return p } -// add a baremetal pxe server +// Add a baremetal PXE server func (s *BaremetalService) AddBaremetalPxeKickStartServer(p *AddBaremetalPxeKickStartServerParams) (*AddBaremetalPxeKickStartServerResponse, error) { resp, err := s.cs.newPostRequest("addBaremetalPxeKickStartServer", p.toURLValues()) if err != nil { @@ -767,7 +767,7 @@ func (s *BaremetalService) NewAddBaremetalPxePingServerParams(password string, p return p } -// add a baremetal ping pxe server +// Add a baremetal ping PXE server func (s *BaremetalService) AddBaremetalPxePingServer(p *AddBaremetalPxePingServerParams) (*AddBaremetalPxePingServerResponse, error) { resp, err := s.cs.newPostRequest("addBaremetalPxePingServer", p.toURLValues()) if err != nil { @@ -859,7 +859,7 @@ func (s *BaremetalService) NewAddBaremetalRctParams(baremetalrcturl string) *Add return p } -// adds baremetal rack configuration text +// Adds baremetal rack configuration text func (s *BaremetalService) AddBaremetalRct(p *AddBaremetalRctParams) (*AddBaremetalRctResponse, error) { resp, err := s.cs.newPostRequest("addBaremetalRct", p.toURLValues()) if err != nil { @@ -946,7 +946,7 @@ func (s *BaremetalService) NewDeleteBaremetalRctParams(id string) *DeleteBaremet return p } -// deletes baremetal rack configuration text +// Deletes baremetal rack configuration text func (s *BaremetalService) DeleteBaremetalRct(p *DeleteBaremetalRctParams) (*DeleteBaremetalRctResponse, error) { resp, err := s.cs.newPostRequest("deleteBaremetalRct", p.toURLValues()) if err != nil { @@ -1151,7 +1151,7 @@ func (s *BaremetalService) NewListBaremetalDhcpParams(physicalnetworkid string) return p } -// list baremetal dhcp servers +// List baremetal dhcp servers func (s *BaremetalService) ListBaremetalDhcp(p *ListBaremetalDhcpParams) (*ListBaremetalDhcpResponse, error) { resp, err := s.cs.newRequest("listBaremetalDhcp", p.toURLValues()) if err != nil { @@ -1325,7 +1325,7 @@ func (s *BaremetalService) NewListBaremetalPxeServersParams(physicalnetworkid st return p } -// list baremetal pxe server +// List baremetal pxe server func (s *BaremetalService) ListBaremetalPxeServers(p *ListBaremetalPxeServersParams) (*ListBaremetalPxeServersResponse, error) { resp, err := s.cs.newRequest("listBaremetalPxeServers", p.toURLValues()) if err != nil { @@ -1448,7 +1448,7 @@ func (s *BaremetalService) NewListBaremetalRctParams() *ListBaremetalRctParams { return p } -// list baremetal rack configuration +// List baremetal rack configuration func (s *BaremetalService) ListBaremetalRct(p *ListBaremetalRctParams) (*ListBaremetalRctResponse, error) { resp, err := s.cs.newRequest("listBaremetalRct", p.toURLValues()) if err != nil { diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index 571b343..f921c87 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -441,7 +441,7 @@ func (s *BrocadeVCSService) GetBrocadeVcsDeviceNetworkID(keyword string, vcsdevi return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// lists network that are using a brocade vcs switch +// Lists network that are using a brocade vcs switch func (s *BrocadeVCSService) ListBrocadeVcsDeviceNetworks(p *ListBrocadeVcsDeviceNetworksParams) (*ListBrocadeVcsDeviceNetworksResponse, error) { resp, err := s.cs.newRequest("listBrocadeVcsDeviceNetworks", p.toURLValues()) if err != nil { diff --git a/cloudstack/CertificateService.go b/cloudstack/CertificateService.go index e2aa402..26c5843 100644 --- a/cloudstack/CertificateService.go +++ b/cloudstack/CertificateService.go @@ -578,7 +578,7 @@ func (s *CertificateService) GetTemplateDirectDownloadCertificateByID(id string, 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 +// List the uploaded certificates for direct download Templates func (s *CertificateService) ListTemplateDirectDownloadCertificates(p *ListTemplateDirectDownloadCertificatesParams) (*ListTemplateDirectDownloadCertificatesResponse, error) { resp, err := s.cs.newRequest("listTemplateDirectDownloadCertificates", p.toURLValues()) if err != nil { @@ -1462,7 +1462,7 @@ func (s *CertificateService) NewUploadTemplateDirectDownloadCertificateParams(ce return p } -// Upload a certificate for HTTPS direct template download on KVM hosts +// Upload a certificate for HTTPS direct Template download on KVM hosts func (s *CertificateService) UploadTemplateDirectDownloadCertificate(p *UploadTemplateDirectDownloadCertificateParams) (*UploadTemplateDirectDownloadCertificateResponse, error) { resp, err := s.cs.newPostRequest("uploadTemplateDirectDownloadCertificate", p.toURLValues()) if err != nil { diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 571b85c..5d110e4 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -125,6 +125,7 @@ type Capability struct { Securitygroupsenabled bool `json:"securitygroupsenabled"` Sharedfsvmmincpucount int `json:"sharedfsvmmincpucount"` Sharedfsvmminramsize int `json:"sharedfsvmminramsize"` + Snapshotshowchainsize bool `json:"snapshotshowchainsize"` SupportELB string `json:"supportELB"` Userpublictemplateenabled bool `json:"userpublictemplateenabled"` } diff --git a/cloudstack/ConsoleEndpointService.go b/cloudstack/ConsoleEndpointService.go index 19bff84..d07d3d8 100644 --- a/cloudstack/ConsoleEndpointService.go +++ b/cloudstack/ConsoleEndpointService.go @@ -99,7 +99,7 @@ func (s *ConsoleEndpointService) NewCreateConsoleEndpointParams(virtualmachineid return p } -// Create a console endpoint to connect to a VM console +// Create a console endpoint to connect to a Instance console func (s *ConsoleEndpointService) CreateConsoleEndpoint(p *CreateConsoleEndpointParams) (*CreateConsoleEndpointResponse, error) { resp, err := s.cs.newPostRequest("createConsoleEndpoint", p.toURLValues()) if err != nil { diff --git a/cloudstack/DiagnosticsService.go b/cloudstack/DiagnosticsService.go index 4351939..6f057d6 100644 --- a/cloudstack/DiagnosticsService.go +++ b/cloudstack/DiagnosticsService.go @@ -102,7 +102,7 @@ func (s *DiagnosticsService) NewGetDiagnosticsDataParams(targetid string) *GetDi return p } -// Get diagnostics and files from system VMs +// Get diagnostics and files from System VMs func (s *DiagnosticsService) GetDiagnosticsData(p *GetDiagnosticsDataParams) (*GetDiagnosticsDataResponse, error) { resp, err := s.cs.newRequest("getDiagnosticsData", p.toURLValues()) if err != nil { @@ -262,7 +262,7 @@ func (s *DiagnosticsService) NewRunDiagnosticsParams(ipaddress string, targetid return p } -// Execute network-utility command (ping/arping/tracert) on system VMs remotely +// Execute network-utility command (ping/arping/tracert) on System VMs remotely func (s *DiagnosticsService) RunDiagnostics(p *RunDiagnosticsParams) (*RunDiagnosticsResponse, error) { resp, err := s.cs.newPostRequest("runDiagnostics", p.toURLValues()) if err != nil { diff --git a/cloudstack/ExtensionService.go b/cloudstack/ExtensionService.go index b565f4a..fe3b281 100644 --- a/cloudstack/ExtensionService.go +++ b/cloudstack/ExtensionService.go @@ -424,6 +424,9 @@ func (p *CreateExtensionParams) toURLValues() url.Values { if v, found := p.p["path"]; found { u.Set("path", v.(string)) } + if v, found := p.p["reservedresourcedetails"]; found { + u.Set("reservedresourcedetails", v.(string)) + } if v, found := p.p["state"]; found { u.Set("state", v.(string)) } @@ -538,6 +541,27 @@ func (p *CreateExtensionParams) GetPath() (string, bool) { return value, ok } +func (p *CreateExtensionParams) SetReservedresourcedetails(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["reservedresourcedetails"] = v +} + +func (p *CreateExtensionParams) ResetReservedresourcedetails() { + if p.p != nil && p.p["reservedresourcedetails"] != nil { + delete(p.p, "reservedresourcedetails") + } +} + +func (p *CreateExtensionParams) GetReservedresourcedetails() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["reservedresourcedetails"].(string) + return value, ok +} + func (p *CreateExtensionParams) SetState(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -606,20 +630,21 @@ func (s *ExtensionService) CreateExtension(p *CreateExtensionParams) (*CreateExt } type CreateExtensionResponse struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []CreateExtensionResponseResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []CreateExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type CreateExtensionResponseResources struct { @@ -808,20 +833,21 @@ func (s *ExtensionService) DeleteExtension(p *DeleteExtensionParams) (*DeleteExt } type DeleteExtensionResponse struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []DeleteExtensionResponseResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []DeleteExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type DeleteExtensionResponseResources struct { @@ -1472,20 +1498,21 @@ type ListExtensionsResponse struct { } type Extension struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []ExtensionResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []ExtensionResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type ExtensionResources struct { @@ -1634,20 +1661,21 @@ func (s *ExtensionService) RegisterExtension(p *RegisterExtensionParams) (*Regis } type RegisterExtensionResponse struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []RegisterExtensionResponseResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []RegisterExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type RegisterExtensionResponseResources struct { @@ -1935,20 +1963,21 @@ func (s *ExtensionService) UnregisterExtension(p *UnregisterExtensionParams) (*U } type UnregisterExtensionResponse struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []UnregisterExtensionResponseResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []UnregisterExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type UnregisterExtensionResponseResources struct { @@ -2358,6 +2387,9 @@ func (p *UpdateExtensionParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("orchestratorrequirespreparevm", vv) } + if v, found := p.p["reservedresourcedetails"]; found { + u.Set("reservedresourcedetails", v.(string)) + } if v, found := p.p["state"]; found { u.Set("state", v.(string)) } @@ -2469,6 +2501,27 @@ func (p *UpdateExtensionParams) GetOrchestratorrequirespreparevm() (bool, bool) return value, ok } +func (p *UpdateExtensionParams) SetReservedresourcedetails(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["reservedresourcedetails"] = v +} + +func (p *UpdateExtensionParams) ResetReservedresourcedetails() { + if p.p != nil && p.p["reservedresourcedetails"] != nil { + delete(p.p, "reservedresourcedetails") + } +} + +func (p *UpdateExtensionParams) GetReservedresourcedetails() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["reservedresourcedetails"].(string) + return value, ok +} + func (p *UpdateExtensionParams) SetState(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2515,20 +2568,21 @@ func (s *ExtensionService) UpdateExtension(p *UpdateExtensionParams) (*UpdateExt } type UpdateExtensionResponse struct { - Created string `json:"created"` - Description string `json:"description"` - Details map[string]string `json:"details"` - Id string `json:"id"` - Isuserdefined bool `json:"isuserdefined"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Path string `json:"path"` - Pathready bool `json:"pathready"` - Removed string `json:"removed"` - Resources []UpdateExtensionResponseResources `json:"resources"` - State string `json:"state"` - Type string `json:"type"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Reservedresourcedetails string `json:"reservedresourcedetails"` + Resources []UpdateExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` } type UpdateExtensionResponseResources struct { diff --git a/cloudstack/FirewallService.go b/cloudstack/FirewallService.go index c299de5..e6b78c0 100644 --- a/cloudstack/FirewallService.go +++ b/cloudstack/FirewallService.go @@ -3231,7 +3231,7 @@ func (s *FirewallService) NewListPaloAltoFirewallsParams() *ListPaloAltoFirewall return p } -// lists Palo Alto firewall devices in a physical network +// Lists Palo Alto firewall devices in a physical Network func (s *FirewallService) ListPaloAltoFirewalls(p *ListPaloAltoFirewallsParams) (*ListPaloAltoFirewallsResponse, error) { resp, err := s.cs.newRequest("listPaloAltoFirewalls", p.toURLValues()) if err != nil { @@ -4644,7 +4644,7 @@ func (s *FirewallService) NewUpdatePortForwardingRuleParams(id string) *UpdatePo return p } -// Updates a port forwarding rule. Only the private port and the virtual machine can be updated. +// Updates a port forwarding rule. Only the private port and the Instance can be updated. func (s *FirewallService) UpdatePortForwardingRule(p *UpdatePortForwardingRuleParams) (*UpdatePortForwardingRuleResponse, error) { resp, err := s.cs.newPostRequest("updatePortForwardingRule", p.toURLValues()) if err != nil { @@ -5396,7 +5396,7 @@ func (s *FirewallService) NewCreateIpv6FirewallRuleParams(networkid string, prot return p } -// Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC) +// Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC) func (s *FirewallService) CreateIpv6FirewallRule(p *CreateIpv6FirewallRuleParams) (*CreateIpv6FirewallRuleResponse, error) { resp, err := s.cs.newPostRequest("createIpv6FirewallRule", p.toURLValues()) if err != nil { diff --git a/cloudstack/GuestOSService.go b/cloudstack/GuestOSService.go index f7dd0c0..06c0331 100644 --- a/cloudstack/GuestOSService.go +++ b/cloudstack/GuestOSService.go @@ -1270,6 +1270,10 @@ func (p *ListOsTypesParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -1350,6 +1354,27 @@ func (p *ListOsTypesParams) GetId() (string, bool) { return value, ok } +func (p *ListOsTypesParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *ListOsTypesParams) ResetIds() { + if p.p != nil && p.p["ids"] != nil { + delete(p.p, "ids") + } +} + +func (p *ListOsTypesParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + func (p *ListOsTypesParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index 16f9009..dea15fe 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -444,7 +444,7 @@ func (s *HostService) NewAddBaremetalHostParams(hypervisor string, podid string, return p } -// add a baremetal host +// Add a baremetal host func (s *HostService) AddBaremetalHost(p *AddBaremetalHostParams) (*AddBaremetalHostResponse, error) { resp, err := s.cs.newPostRequest("addBaremetalHost", p.toURLValues()) if err != nil { @@ -1154,6 +1154,12 @@ func (p *AddSecondaryStorageParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -1163,6 +1169,27 @@ func (p *AddSecondaryStorageParams) toURLValues() url.Values { return u } +func (p *AddSecondaryStorageParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *AddSecondaryStorageParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *AddSecondaryStorageParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + func (p *AddSecondaryStorageParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2312,7 +2339,7 @@ func (s *HostService) NewFindHostsForMigrationParams(virtualmachineid string) *F return p } -// Find hosts suitable for migrating a virtual machine. +// Find hosts suitable for migrating an Instance. func (s *HostService) FindHostsForMigration(p *FindHostsForMigrationParams) (*FindHostsForMigrationResponse, error) { resp, err := s.cs.newRequest("findHostsForMigration", p.toURLValues()) if err != nil { @@ -2877,6 +2904,9 @@ func (p *ListHostsParams) toURLValues() url.Values { if v, found := p.p["type"]; found { u.Set("type", v.(string)) } + if v, found := p.p["version"]; found { + u.Set("version", v.(string)) + } if v, found := p.p["virtualmachineid"]; found { u.Set("virtualmachineid", v.(string)) } @@ -3264,6 +3294,27 @@ func (p *ListHostsParams) GetType() (string, bool) { return value, ok } +func (p *ListHostsParams) SetVersion(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["version"] = v +} + +func (p *ListHostsParams) ResetVersion() { + if p.p != nil && p.p["version"] != nil { + delete(p.p, "version") + } +} + +func (p *ListHostsParams) GetVersion() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["version"].(string) + return value, ok +} + func (p *ListHostsParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3581,6 +3632,9 @@ func (p *ListHostsMetricsParams) toURLValues() url.Values { if v, found := p.p["type"]; found { u.Set("type", v.(string)) } + if v, found := p.p["version"]; found { + u.Set("version", v.(string)) + } if v, found := p.p["virtualmachineid"]; found { u.Set("virtualmachineid", v.(string)) } @@ -3968,6 +4022,27 @@ func (p *ListHostsMetricsParams) GetType() (string, bool) { return value, ok } +func (p *ListHostsMetricsParams) SetVersion(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["version"] = v +} + +func (p *ListHostsMetricsParams) ResetVersion() { + if p.p != nil && p.p["version"] != nil { + delete(p.p, "version") + } +} + +func (p *ListHostsMetricsParams) GetVersion() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["version"].(string) + return value, ok +} + func (p *ListHostsMetricsParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5418,7 +5493,7 @@ func (s *HostService) NewMigrateSecondaryStorageDataParams(destpools []string, s return p } -// migrates data objects from one secondary storage to destination image store(s) +// Migrates data objects from one secondary storage to destination image store(s) func (s *HostService) MigrateSecondaryStorageData(p *MigrateSecondaryStorageDataParams) (*MigrateSecondaryStorageDataResponse, error) { resp, err := s.cs.newPostRequest("migrateSecondaryStorageData", p.toURLValues()) if err != nil { @@ -6339,7 +6414,7 @@ func (s *HostService) NewDeclareHostAsDegradedParams(id string) *DeclareHostAsDe return p } -// 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. +// Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host. func (s *HostService) DeclareHostAsDegraded(p *DeclareHostAsDegradedParams) (*DeclareHostAsDegradedResponse, error) { resp, err := s.cs.newPostRequest("declareHostAsDegraded", p.toURLValues()) if err != nil { diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 5000bc5..4f25a06 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -151,7 +151,7 @@ func (s *ISOService) NewAttachIsoParams(id string, virtualmachineid string) *Att return p } -// Attaches an ISO to a virtual machine. +// Attaches an ISO to an Instance. func (s *ISOService) AttachIso(p *AttachIsoParams) (*AttachIsoResponse, error) { resp, err := s.cs.newPostRequest("attachIso", p.toURLValues()) if err != nil { @@ -189,6 +189,7 @@ func (s *ISOService) AttachIso(p *AttachIsoParams) (*AttachIsoResponse, error) { type AttachIsoResponse struct { Account string `json:"account"` Affinitygroup []AttachIsoResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -485,7 +486,7 @@ func (s *ISOService) NewCopyIsoParams(id string) *CopyIsoParams { return p } -// Copies an iso from one zone to another. +// Copies an ISO from one zone to another. func (s *ISOService) CopyIso(p *CopyIsoParams) (*CopyIsoResponse, error) { resp, err := s.cs.newPostRequest("copyIso", p.toURLValues()) if err != nil { @@ -785,7 +786,7 @@ func (s *ISOService) NewDetachIsoParams(virtualmachineid string) *DetachIsoParam return p } -// Detaches any ISO file (if any) currently attached to a virtual machine. +// Detaches any ISO file (if any) currently attached to an Instance. func (s *ISOService) DetachIso(p *DetachIsoParams) (*DetachIsoResponse, error) { resp, err := s.cs.newPostRequest("detachIso", p.toURLValues()) if err != nil { @@ -823,6 +824,7 @@ func (s *ISOService) DetachIso(p *DetachIsoParams) (*DetachIsoResponse, error) { type DetachIsoResponse struct { Account string `json:"account"` Affinitygroup []DetachIsoResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -1512,7 +1514,7 @@ func (s *ISOService) NewGetUploadParamsForIsoParams(format string, name string, return p } -// upload an existing ISO into the CloudStack cloud. +// Upload an existing ISO into the CloudStack cloud. func (s *ISOService) GetUploadParamsForIso(p *GetUploadParamsForIsoParams) (*GetUploadParamsForIsoResponse, error) { resp, err := s.cs.newRequest("getUploadParamsForIso", p.toURLValues()) if err != nil { @@ -1615,7 +1617,7 @@ func (s *ISOService) GetIsoPermissionByID(id string, opts ...OptionFunc) (*IsoPe return nil, l.Count, fmt.Errorf("There is more then one result for IsoPermission UUID: %s!", id) } -// List iso visibility and all accounts that have permissions to view this iso. +// List ISO visibility and all accounts that have permissions to view this ISO. func (s *ISOService) ListIsoPermissions(p *ListIsoPermissionsParams) (*ListIsoPermissionsResponse, error) { resp, err := s.cs.newRequest("listIsoPermissions", p.toURLValues()) if err != nil { diff --git a/cloudstack/ImageStoreService.go b/cloudstack/ImageStoreService.go index 8ff7f9b..2eb4d9a 100644 --- a/cloudstack/ImageStoreService.go +++ b/cloudstack/ImageStoreService.go @@ -713,7 +713,7 @@ func (s *ImageStoreService) NewCreateSecondaryStagingStoreParams(url string) *Cr return p } -// create secondary staging store. +// Create secondary staging store. func (s *ImageStoreService) CreateSecondaryStagingStore(p *CreateSecondaryStagingStoreParams) (*CreateSecondaryStagingStoreResponse, error) { resp, err := s.cs.newPostRequest("createSecondaryStagingStore", p.toURLValues()) if err != nil { diff --git a/cloudstack/InfrastructureUsageService.go b/cloudstack/InfrastructureUsageService.go index 6a3812d..1eff148 100644 --- a/cloudstack/InfrastructureUsageService.go +++ b/cloudstack/InfrastructureUsageService.go @@ -49,7 +49,7 @@ func (s *InfrastructureUsageService) NewListDbMetricsParams() *ListDbMetricsPara return p } -// list the db hosts and statistics +// 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 { diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index 1e2c53c..b903807 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -1017,7 +1017,7 @@ func (s *InternalLBService) GetInternalLoadBalancerVMByID(id string, opts ...Opt return nil, l.Count, fmt.Errorf("There is more then one result for InternalLoadBalancerVM UUID: %s!", id) } -// List internal LB VMs. +// List internal LB Instances. func (s *InternalLBService) ListInternalLoadBalancerVMs(p *ListInternalLoadBalancerVMsParams) (*ListInternalLoadBalancerVMsResponse, error) { resp, err := s.cs.newRequest("listInternalLoadBalancerVMs", p.toURLValues()) if err != nil { @@ -1151,7 +1151,7 @@ func (s *InternalLBService) NewStartInternalLoadBalancerVMParams(id string) *Sta return p } -// Starts an existing internal lb vm. +// Starts an existing Internal LB Instance. func (s *InternalLBService) StartInternalLoadBalancerVM(p *StartInternalLoadBalancerVMParams) (*StartInternalLoadBalancerVMResponse, error) { resp, err := s.cs.newPostRequest("startInternalLoadBalancerVM", p.toURLValues()) if err != nil { @@ -1325,7 +1325,7 @@ func (s *InternalLBService) NewStopInternalLoadBalancerVMParams(id string) *Stop return p } -// Stops an Internal LB vm. +// Stops an Internal LB Instance. func (s *InternalLBService) StopInternalLoadBalancerVM(p *StopInternalLoadBalancerVMParams) (*StopInternalLoadBalancerVMResponse, error) { resp, err := s.cs.newPostRequest("stopInternalLoadBalancerVM", p.toURLValues()) if err != nil { diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 0ce0afb..040e6ae 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -337,6 +337,7 @@ type AddKubernetesSupportedVersionResponse struct { Isoid string `json:"isoid"` Isoname string `json:"isoname"` Isostate string `json:"isostate"` + Isourl string `json:"isourl"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Mincpunumber int `json:"mincpunumber"` @@ -2207,6 +2208,7 @@ type KubernetesSupportedVersion struct { Isoid string `json:"isoid"` Isoname string `json:"isoname"` Isostate string `json:"isostate"` + Isourl string `json:"isourl"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Mincpunumber int `json:"mincpunumber"` @@ -2838,6 +2840,7 @@ type UpdateKubernetesSupportedVersionResponse struct { Isoid string `json:"isoid"` Isoname string `json:"isoname"` Isostate string `json:"isostate"` + Isourl string `json:"isourl"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Mincpunumber int `json:"mincpunumber"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index b2ab062..824f6b3 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -1500,7 +1500,7 @@ func (s *LDAPService) NewLinkDomainToLdapParams(accounttype int, domainid string return p } -// link an existing cloudstack domain to group or OU in ldap +// Link an existing Cloudstack domain to group or OU in ldap func (s *LDAPService) LinkDomainToLdap(p *LinkDomainToLdapParams) (*LinkDomainToLdapResponse, error) { resp, err := s.cs.newPostRequest("linkDomainToLdap", p.toURLValues()) if err != nil { diff --git a/cloudstack/LoadBalancerService.go b/cloudstack/LoadBalancerService.go index c66a8c0..275f271 100644 --- a/cloudstack/LoadBalancerService.go +++ b/cloudstack/LoadBalancerService.go @@ -477,7 +477,7 @@ func (s *LoadBalancerService) NewAssignToLoadBalancerRuleParams(id string) *Assi return p } -// Assigns virtual machine or a list of virtual machines to a load balancer rule. +// Assigns an Instance or a list of Instances to a load balancer rule. func (s *LoadBalancerService) AssignToLoadBalancerRule(p *AssignToLoadBalancerRuleParams) (*AssignToLoadBalancerRuleResponse, error) { resp, err := s.cs.newPostRequest("assignToLoadBalancerRule", p.toURLValues()) if err != nil { @@ -4011,7 +4011,7 @@ func (s *LoadBalancerService) GetLoadBalancerRuleInstanceByID(id string, opts .. return nil, l.Count, fmt.Errorf("There is more then one result for LoadBalancerRuleInstance UUID: %s!", id) } -// List all virtual machine instances that are assigned to a load balancer rule. +// List all Instances that are assigned to a load balancer rule. func (s *LoadBalancerService) ListLoadBalancerRuleInstances(p *ListLoadBalancerRuleInstancesParams) (*ListLoadBalancerRuleInstancesResponse, error) { resp, err := s.cs.newRequest("listLoadBalancerRuleInstances", p.toURLValues()) if err != nil { @@ -5263,7 +5263,7 @@ func (s *LoadBalancerService) GetRegisteredServicePackageID(keyword string, opts return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// lists registered service packages +// Lists registered service packages func (s *LoadBalancerService) ListRegisteredServicePackages(p *ListRegisteredServicePackagesParams) (*ListRegisteredServicePackagesResponse, error) { resp, err := s.cs.newRequest("listRegisteredServicePackages", p.toURLValues()) if err != nil { @@ -5731,7 +5731,7 @@ func (s *LoadBalancerService) NewRemoveFromLoadBalancerRuleParams(id string) *Re return p } -// Removes a virtual machine or a list of virtual machines from a load balancer rule. +// Removes an Instance or a list of Instances from a load balancer rule. func (s *LoadBalancerService) RemoveFromLoadBalancerRule(p *RemoveFromLoadBalancerRuleParams) (*RemoveFromLoadBalancerRuleResponse, error) { resp, err := s.cs.newPostRequest("removeFromLoadBalancerRule", p.toURLValues()) if err != nil { @@ -6059,7 +6059,7 @@ func (s *LoadBalancerService) NewUpdateGlobalLoadBalancerRuleParams(id string) * return p } -// update global load balancer rules. +// Update global load balancer rules. func (s *LoadBalancerService) UpdateGlobalLoadBalancerRule(p *UpdateGlobalLoadBalancerRuleParams) (*UpdateGlobalLoadBalancerRuleResponse, error) { resp, err := s.cs.newPostRequest("updateGlobalLoadBalancerRule", p.toURLValues()) if err != nil { diff --git a/cloudstack/ManagementService.go b/cloudstack/ManagementService.go index a8370f2..642b398 100644 --- a/cloudstack/ManagementService.go +++ b/cloudstack/ManagementService.go @@ -151,6 +151,9 @@ func (p *ListManagementServersParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("peers", vv) } + if v, found := p.p["version"]; found { + u.Set("version", v.(string)) + } return u } @@ -280,6 +283,27 @@ func (p *ListManagementServersParams) GetPeers() (bool, bool) { return value, ok } +func (p *ListManagementServersParams) SetVersion(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["version"] = v +} + +func (p *ListManagementServersParams) ResetVersion() { + if p.p != nil && p.p["version"] != nil { + delete(p.p, "version") + } +} + +func (p *ListManagementServersParams) GetVersion() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["version"].(string) + return value, ok +} + // You should always use this function to get a new ListManagementServersParams instance, // as then you are sure you have configured all required params func (s *ManagementService) NewListManagementServersParams() *ListManagementServersParams { @@ -448,6 +472,9 @@ func (p *ListManagementServersMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("system", vv) } + if v, found := p.p["version"]; found { + u.Set("version", v.(string)) + } return u } @@ -598,6 +625,27 @@ func (p *ListManagementServersMetricsParams) GetSystem() (bool, bool) { return value, ok } +func (p *ListManagementServersMetricsParams) SetVersion(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["version"] = v +} + +func (p *ListManagementServersMetricsParams) ResetVersion() { + if p.p != nil && p.p["version"] != nil { + delete(p.p, "version") + } +} + +func (p *ListManagementServersMetricsParams) GetVersion() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["version"].(string) + 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 *ManagementService) NewListManagementServersMetricsParams() *ListManagementServersMetricsParams { diff --git a/cloudstack/NetscalerService.go b/cloudstack/NetscalerService.go index dc17de7..6e8058d 100644 --- a/cloudstack/NetscalerService.go +++ b/cloudstack/NetscalerService.go @@ -492,7 +492,7 @@ func (s *NetscalerService) NewConfigureNetscalerLoadBalancerParams(lbdeviceid st return p } -// configures a netscaler load balancer device +// Configures a netscaler load balancer device func (s *NetscalerService) ConfigureNetscalerLoadBalancer(p *ConfigureNetscalerLoadBalancerParams) (*NetscalerLoadBalancerResponse, error) { resp, err := s.cs.newPostRequest("configureNetscalerLoadBalancer", p.toURLValues()) if err != nil { @@ -817,7 +817,7 @@ func (s *NetscalerService) NewListNetscalerControlCenterParams() *ListNetscalerC return p } -// list control center +// List control center func (s *NetscalerService) ListNetscalerControlCenter(p *ListNetscalerControlCenterParams) (*ListNetscalerControlCenterResponse, error) { resp, err := s.cs.newRequest("listNetscalerControlCenter", p.toURLValues()) if err != nil { @@ -1003,7 +1003,7 @@ func (s *NetscalerService) GetNetscalerLoadBalancerNetworkID(keyword string, lbd return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// lists network that are using a netscaler load balancer device +// Lists network that are using a netscaler load balancer device func (s *NetscalerService) ListNetscalerLoadBalancerNetworks(p *ListNetscalerLoadBalancerNetworksParams) (*ListNetscalerLoadBalancerNetworksResponse, error) { resp, err := s.cs.newRequest("listNetscalerLoadBalancerNetworks", p.toURLValues()) if err != nil { @@ -1269,7 +1269,7 @@ func (s *NetscalerService) NewListNetscalerLoadBalancersParams() *ListNetscalerL return p } -// lists netscaler load balancer devices +// Lists netscaler load balancer devices func (s *NetscalerService) ListNetscalerLoadBalancers(p *ListNetscalerLoadBalancersParams) (*ListNetscalerLoadBalancersResponse, error) { resp, err := s.cs.newRequest("listNetscalerLoadBalancers", p.toURLValues()) if err != nil { diff --git a/cloudstack/NetworkACLService.go b/cloudstack/NetworkACLService.go index b64e873..751ebd9 100644 --- a/cloudstack/NetworkACLService.go +++ b/cloudstack/NetworkACLService.go @@ -394,7 +394,7 @@ func (s *NetworkACLService) NewCreateNetworkACLParams(protocol string) *CreateNe return p } -// Creates a ACL rule in the given network (the network has to belong to VPC) +// Creates a ACL rule in the given Network (the Network has to belong to VPC) func (s *NetworkACLService) CreateNetworkACL(p *CreateNetworkACLParams) (*CreateNetworkACLResponse, error) { resp, err := s.cs.newPostRequest("createNetworkACL", p.toURLValues()) if err != nil { @@ -569,7 +569,7 @@ func (s *NetworkACLService) NewCreateNetworkACLListParams(name string, vpcid str return p } -// Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. +// Creates a Network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. func (s *NetworkACLService) CreateNetworkACLList(p *CreateNetworkACLListParams) (*CreateNetworkACLListResponse, error) { resp, err := s.cs.newPostRequest("createNetworkACLList", p.toURLValues()) if err != nil { @@ -660,7 +660,7 @@ func (s *NetworkACLService) NewDeleteNetworkACLParams(id string) *DeleteNetworkA return p } -// Deletes a network ACL +// Deletes a Network ACL func (s *NetworkACLService) DeleteNetworkACL(p *DeleteNetworkACLParams) (*DeleteNetworkACLResponse, error) { resp, err := s.cs.newPostRequest("deleteNetworkACL", p.toURLValues()) if err != nil { @@ -1858,7 +1858,7 @@ func (s *NetworkACLService) NewMoveNetworkAclItemParams(id string) *MoveNetworkA return p } -// Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list +// Move an ACL rule to a position between two other ACL rules of the same ACL Network list func (s *NetworkACLService) MoveNetworkAclItem(p *MoveNetworkAclItemParams) (*MoveNetworkAclItemResponse, error) { resp, err := s.cs.newPostRequest("moveNetworkAclItem", p.toURLValues()) if err != nil { @@ -2607,7 +2607,7 @@ func (s *NetworkACLService) NewUpdateNetworkACLListParams(id string) *UpdateNetw return p } -// Updates network ACL list +// Updates Network ACL list func (s *NetworkACLService) UpdateNetworkACLList(p *UpdateNetworkACLListParams) (*UpdateNetworkACLListResponse, error) { resp, err := s.cs.newPostRequest("updateNetworkACLList", p.toURLValues()) if err != nil { diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 96f1a2e..8e90edc 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -1766,7 +1766,7 @@ func (s *NetworkService) NewCreateNetworkParams(name string, networkofferingid s return p } -// Creates a network +// Creates a Network func (s *NetworkService) CreateNetwork(p *CreateNetworkParams) (*CreateNetworkResponse, error) { resp, err := s.cs.newPostRequest("createNetwork", p.toURLValues()) if err != nil { @@ -2105,7 +2105,7 @@ func (s *NetworkService) NewCreatePhysicalNetworkParams(name string, zoneid stri return p } -// Creates a physical network +// Creates a physical Network func (s *NetworkService) CreatePhysicalNetwork(p *CreatePhysicalNetworkParams) (*CreatePhysicalNetworkResponse, error) { resp, err := s.cs.newPostRequest("createPhysicalNetwork", p.toURLValues()) if err != nil { @@ -2981,7 +2981,7 @@ func (s *NetworkService) NewDeleteNetworkParams(id string) *DeleteNetworkParams return p } -// Deletes a network +// Deletes a Network func (s *NetworkService) DeleteNetwork(p *DeleteNetworkParams) (*DeleteNetworkResponse, error) { resp, err := s.cs.newPostRequest("deleteNetwork", p.toURLValues()) if err != nil { @@ -5212,7 +5212,7 @@ func (s *NetworkService) GetNiciraNvpDeviceNetworkID(keyword string, nvpdeviceid return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// lists network that are using a nicira nvp device +// Lists network that are using a nicira nvp device func (s *NetworkService) ListNiciraNvpDeviceNetworks(p *ListNiciraNvpDeviceNetworksParams) (*ListNiciraNvpDeviceNetworksResponse, error) { resp, err := s.cs.newRequest("listNiciraNvpDeviceNetworks", p.toURLValues()) if err != nil { @@ -5623,7 +5623,7 @@ func (s *NetworkService) GetPaloAltoFirewallNetworkID(keyword string, lbdeviceid return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) } -// lists network that are using Palo Alto firewall device +// Lists Network that are using Palo Alto firewall device func (s *NetworkService) ListPaloAltoFirewallNetworks(p *ListPaloAltoFirewallNetworksParams) (*ListPaloAltoFirewallNetworksResponse, error) { resp, err := s.cs.newRequest("listPaloAltoFirewallNetworks", p.toURLValues()) if err != nil { @@ -6546,7 +6546,7 @@ func (s *NetworkService) NewMigrateNetworkParams(networkid string, networkofferi return p } -// moves a network to another physical network +// Moves a network to another physical network func (s *NetworkService) MigrateNetwork(p *MigrateNetworkParams) (*MigrateNetworkResponse, error) { resp, err := s.cs.newPostRequest("migrateNetwork", p.toURLValues()) if err != nil { @@ -6899,7 +6899,7 @@ func (s *NetworkService) NewRestartNetworkParams(id string) *RestartNetworkParam return p } -// Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules +// Restarts the Network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules func (s *NetworkService) RestartNetwork(p *RestartNetworkParams) (*RestartNetworkResponse, error) { resp, err := s.cs.newPostRequest("restartNetwork", p.toURLValues()) if err != nil { @@ -8704,7 +8704,7 @@ func (s *NetworkService) NewResetNetworkPermissionsParams(networkid string) *Res return p } -// Resets network permissions. +// Resets Network permissions. func (s *NetworkService) ResetNetworkPermissions(p *ResetNetworkPermissionsParams) (*ResetNetworkPermissionsResponse, error) { resp, err := s.cs.newPostRequest("resetNetworkPermissions", p.toURLValues()) if err != nil { @@ -8798,7 +8798,7 @@ func (s *NetworkService) NewListNetworkPermissionsParams(networkid string) *List return p } -// List network visibility and all accounts that have permissions to view this network. +// 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 { @@ -8950,7 +8950,7 @@ func (s *NetworkService) NewRemoveNetworkPermissionsParams(networkid string) *Re return p } -// Removes network permissions. +// Removes Network permissions. func (s *NetworkService) RemoveNetworkPermissions(p *RemoveNetworkPermissionsParams) (*RemoveNetworkPermissionsResponse, error) { resp, err := s.cs.newPostRequest("removeNetworkPermissions", p.toURLValues()) if err != nil { diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 3fe8f33..eee7d36 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -346,7 +346,7 @@ func (s *NicService) NewListNicsParams(virtualmachineid string) *ListNicsParams return p } -// list the vm nics IP to NIC +// List the Instance NICs IP to NIC func (s *NicService) ListNics(p *ListNicsParams) (*ListNicsResponse, error) { resp, err := s.cs.newRequest("listNics", p.toURLValues()) if err != nil { @@ -556,7 +556,7 @@ func (s *NicService) NewUpdateVmNicIpParams(nicid string) *UpdateVmNicIpParams { return p } -// Update the default Ip of a VM Nic +// Update the default IP of an Instance NIC func (s *NicService) UpdateVmNicIp(p *UpdateVmNicIpParams) (*UpdateVmNicIpResponse, error) { resp, err := s.cs.newPostRequest("updateVmNicIp", p.toURLValues()) if err != nil { @@ -594,6 +594,7 @@ func (s *NicService) UpdateVmNicIp(p *UpdateVmNicIpParams) (*UpdateVmNicIpRespon type UpdateVmNicIpResponse struct { Account string `json:"account"` Affinitygroup []UpdateVmNicIpResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` diff --git a/cloudstack/PortableIPService.go b/cloudstack/PortableIPService.go index 92ec0e3..59a497f 100644 --- a/cloudstack/PortableIPService.go +++ b/cloudstack/PortableIPService.go @@ -207,7 +207,7 @@ func (s *PortableIPService) NewCreatePortableIpRangeParams(endip string, gateway return p } -// adds a range of portable public IP's to a region +// Adds a range of portable public IP's to a region func (s *PortableIPService) CreatePortableIpRange(p *CreatePortableIpRangeParams) (*CreatePortableIpRangeResponse, error) { resp, err := s.cs.newPostRequest("createPortableIpRange", p.toURLValues()) if err != nil { @@ -313,7 +313,7 @@ func (s *PortableIPService) NewDeletePortableIpRangeParams(id string) *DeletePor return p } -// deletes a range of portable public IP's associated with a region +// Deletes a range of portable public IP's associated with a region func (s *PortableIPService) DeletePortableIpRange(p *DeletePortableIpRangeParams) (*DeletePortableIpRangeResponse, error) { resp, err := s.cs.newPostRequest("deletePortableIpRange", p.toURLValues()) if err != nil { @@ -526,7 +526,7 @@ func (s *PortableIPService) GetPortableIpRangeByID(id string, opts ...OptionFunc return nil, l.Count, fmt.Errorf("There is more then one result for PortableIpRange UUID: %s!", id) } -// list portable IP ranges +// List portable IP ranges func (s *PortableIPService) ListPortableIpRanges(p *ListPortableIpRangesParams) (*ListPortableIpRangesResponse, error) { resp, err := s.cs.newRequest("listPortableIpRanges", p.toURLValues()) if err != nil { diff --git a/cloudstack/ProjectService.go b/cloudstack/ProjectService.go index bbafee4..e761ecb 100644 --- a/cloudstack/ProjectService.go +++ b/cloudstack/ProjectService.go @@ -362,7 +362,7 @@ func (s *ProjectService) NewAddAccountToProjectParams(projectid string) *AddAcco return p } -// Adds account to a project +// Adds Account to a project func (s *ProjectService) AddAccountToProject(p *AddAccountToProjectParams) (*AddAccountToProjectResponse, error) { resp, err := s.cs.newPostRequest("addAccountToProject", p.toURLValues()) if err != nil { @@ -541,7 +541,7 @@ func (s *ProjectService) NewAddUserToProjectParams(projectid string, username st return p } -// Adds user to a project +// Adds User to a project func (s *ProjectService) AddUserToProject(p *AddUserToProjectParams) (*AddUserToProjectResponse, error) { resp, err := s.cs.newPostRequest("addUserToProject", p.toURLValues()) if err != nil { @@ -916,7 +916,7 @@ func (s *ProjectService) NewDeleteAccountFromProjectParams(account string, proje return p } -// Deletes account from the project +// Deletes Account from the project func (s *ProjectService) DeleteAccountFromProject(p *DeleteAccountFromProjectParams) (*DeleteAccountFromProjectResponse, error) { resp, err := s.cs.newPostRequest("deleteAccountFromProject", p.toURLValues()) if err != nil { @@ -1023,7 +1023,7 @@ func (s *ProjectService) NewDeleteUserFromProjectParams(projectid string, userid return p } -// Deletes user from the project +// Deletes User from the project func (s *ProjectService) DeleteUserFromProject(p *DeleteUserFromProjectParams) (*DeleteUserFromProjectResponse, error) { resp, err := s.cs.newPostRequest("deleteUserFromProject", p.toURLValues()) if err != nil { diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index ac50a38..e47fdd0 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -362,7 +362,7 @@ func (s *QuotaService) NewQuotaCreditsParams(account string, domainid string, va return p } -// Add +-credits to an account +// Add +-credits to an Account func (s *QuotaService) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsResponse, error) { resp, err := s.cs.newPostRequest("quotaCredits", p.toURLValues()) if err != nil { @@ -800,7 +800,7 @@ func (s *QuotaService) NewQuotaSummaryParams() *QuotaSummaryParams { return p } -// Lists balance and quota usage for all accounts +// Lists balance and quota usage for all Accounts func (s *QuotaService) QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) { resp, err := s.cs.newRequest("quotaSummary", p.toURLValues()) if err != nil { diff --git a/cloudstack/ResourceIconService.go b/cloudstack/ResourceIconService.go index 45e1e12..1af9a52 100644 --- a/cloudstack/ResourceIconService.go +++ b/cloudstack/ResourceIconService.go @@ -106,7 +106,7 @@ func (s *ResourceIconService) NewDeleteResourceIconParams(resourceids []string, return p } -// deletes the resource icon from the specified resource(s) +// Deletes the resource icon from the specified resource(s) func (s *ResourceIconService) DeleteResourceIcon(p *DeleteResourceIconParams) (*DeleteResourceIconResponse, error) { resp, err := s.cs.newPostRequest("deleteResourceIcon", p.toURLValues()) if err != nil { diff --git a/cloudstack/ResourcemetadataService.go b/cloudstack/ResourcemetadataService.go index 28f35b0..df2db58 100644 --- a/cloudstack/ResourcemetadataService.go +++ b/cloudstack/ResourcemetadataService.go @@ -269,7 +269,7 @@ func (s *ResourcemetadataService) NewListDetailOptionsParams(resourcetype string return p } -// Lists all possible details and their options for a resource type such as a VM or a template +// Lists all possible details and their options for a resource type such as an Instance or a Template func (s *ResourcemetadataService) ListDetailOptions(p *ListDetailOptionsParams) (*ListDetailOptionsResponse, error) { resp, err := s.cs.newRequest("listDetailOptions", p.toURLValues()) if err != nil { diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 30038d4..9c583d8 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -1106,7 +1106,7 @@ func (s *SSHService) NewResetSSHKeyForVirtualMachineParams(id string) *ResetSSHK return p } -// Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] +// Resets the SSH Key for Instance. The Instance must be in a "Stopped" state. [async] func (s *SSHService) ResetSSHKeyForVirtualMachine(p *ResetSSHKeyForVirtualMachineParams) (*ResetSSHKeyForVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("resetSSHKeyForVirtualMachine", p.toURLValues()) if err != nil { @@ -1144,6 +1144,7 @@ func (s *SSHService) ResetSSHKeyForVirtualMachine(p *ResetSSHKeyForVirtualMachin type ResetSSHKeyForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetSSHKeyForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index ab11f36..6f497b9 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -112,7 +112,7 @@ func (s *SnapshotService) NewArchiveSnapshotParams(id string) *ArchiveSnapshotPa return p } -// Archives (moves) a snapshot on primary storage to secondary storage +// Archives (moves) a Snapshot on primary storage to secondary storage func (s *SnapshotService) ArchiveSnapshot(p *ArchiveSnapshotParams) (*ArchiveSnapshotResponse, error) { resp, err := s.cs.newPostRequest("archiveSnapshot", p.toURLValues()) if err != nil { @@ -168,6 +168,8 @@ type ArchiveSnapshotResponse struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -436,6 +438,8 @@ type CopySnapshotResponse struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -798,7 +802,7 @@ func (s *SnapshotService) NewCreateSnapshotParams(volumeid string) *CreateSnapsh return p } -// Creates an instant snapshot of a volume. +// Creates an instant Snapshot of a volume. func (s *SnapshotService) CreateSnapshot(p *CreateSnapshotParams) (*CreateSnapshotResponse, error) { resp, err := s.cs.newPostRequest("createSnapshot", p.toURLValues()) if err != nil { @@ -854,6 +858,8 @@ type CreateSnapshotResponse struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -992,7 +998,7 @@ func (s *SnapshotService) NewCreateSnapshotFromVMSnapshotParams(vmsnapshotid str return p } -// Creates an instant snapshot of a volume from existing vm snapshot. +// Creates an instant Snapshot of a volume from existing Instance Snapshot. func (s *SnapshotService) CreateSnapshotFromVMSnapshot(p *CreateSnapshotFromVMSnapshotParams) (*CreateSnapshotFromVMSnapshotResponse, error) { resp, err := s.cs.newPostRequest("createSnapshotFromVMSnapshot", p.toURLValues()) if err != nil { @@ -1048,6 +1054,8 @@ type CreateSnapshotFromVMSnapshotResponse struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -1366,7 +1374,7 @@ func (s *SnapshotService) NewCreateSnapshotPolicyParams(intervaltype string, max return p } -// Creates a snapshot policy for the account. +// Creates a Snapshot policy for the account. func (s *SnapshotService) CreateSnapshotPolicy(p *CreateSnapshotPolicyParams) (*CreateSnapshotPolicyResponse, error) { resp, err := s.cs.newPostRequest("createSnapshotPolicy", p.toURLValues()) if err != nil { @@ -1541,7 +1549,7 @@ func (s *SnapshotService) NewCreateVMSnapshotParams(virtualmachineid string) *Cr return p } -// Creates snapshot for a vm. +// Creates Snapshot for an Instance. func (s *SnapshotService) CreateVMSnapshot(p *CreateVMSnapshotParams) (*CreateVMSnapshotResponse, error) { resp, err := s.cs.newPostRequest("createVMSnapshot", p.toURLValues()) if err != nil { @@ -1673,7 +1681,7 @@ func (s *SnapshotService) NewDeleteSnapshotParams(id string) *DeleteSnapshotPara return p } -// Deletes a snapshot of a disk volume. +// Deletes a Snapshot of a disk volume. func (s *SnapshotService) DeleteSnapshot(p *DeleteSnapshotParams) (*DeleteSnapshotResponse, error) { resp, err := s.cs.newPostRequest("deleteSnapshot", p.toURLValues()) if err != nil { @@ -1779,7 +1787,7 @@ func (s *SnapshotService) NewDeleteSnapshotPoliciesParams() *DeleteSnapshotPolic return p } -// Deletes snapshot policies for the account. +// Deletes Snapshot policies for the account. func (s *SnapshotService) DeleteSnapshotPolicies(p *DeleteSnapshotPoliciesParams) (*DeleteSnapshotPoliciesResponse, error) { resp, err := s.cs.newPostRequest("deleteSnapshotPolicies", p.toURLValues()) if err != nil { @@ -1873,7 +1881,7 @@ func (s *SnapshotService) NewDeleteVMSnapshotParams(vmsnapshotid string) *Delete return p } -// Deletes a vmsnapshot. +// Deletes an Instance Snapshot. func (s *SnapshotService) DeleteVMSnapshot(p *DeleteVMSnapshotParams) (*DeleteVMSnapshotResponse, error) { resp, err := s.cs.newPostRequest("deleteVMSnapshot", p.toURLValues()) if err != nil { @@ -2356,7 +2364,7 @@ func (s *SnapshotService) GetSnapshotPolicyByID(id string, opts ...OptionFunc) ( return nil, l.Count, fmt.Errorf("There is more then one result for SnapshotPolicy UUID: %s!", id) } -// Lists snapshot policies. +// Lists Snapshot policies. func (s *SnapshotService) ListSnapshotPolicies(p *ListSnapshotPoliciesParams) (*ListSnapshotPoliciesResponse, error) { resp, err := s.cs.newRequest("listSnapshotPolicies", p.toURLValues()) if err != nil { @@ -3027,6 +3035,8 @@ type Snapshot struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -3472,7 +3482,7 @@ func (s *SnapshotService) GetVMSnapshotID(name string, opts ...OptionFunc) (stri return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) } -// List virtual machine snapshot by conditions +// List Instance Snapshot by conditions func (s *SnapshotService) ListVMSnapshot(p *ListVMSnapshotParams) (*ListVMSnapshotResponse, error) { resp, err := s.cs.newRequest("listVMSnapshot", p.toURLValues()) if err != nil { @@ -3565,7 +3575,7 @@ func (s *SnapshotService) NewRevertSnapshotParams(id string) *RevertSnapshotPara return p } -// This is supposed to revert a volume snapshot. This command is only supported with KVM so far +// This is supposed to revert a volume Snapshot. This command is only supported with KVM so far func (s *SnapshotService) RevertSnapshot(p *RevertSnapshotParams) (*RevertSnapshotResponse, error) { resp, err := s.cs.newPostRequest("revertSnapshot", p.toURLValues()) if err != nil { @@ -3621,6 +3631,8 @@ type RevertSnapshotResponse struct { Name string `json:"name"` Osdisplayname string `json:"osdisplayname"` Ostypeid string `json:"ostypeid"` + Parent string `json:"parent"` + Parentname string `json:"parentname"` Physicalsize int64 `json:"physicalsize"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -3710,7 +3722,7 @@ func (s *SnapshotService) NewRevertToVMSnapshotParams(vmsnapshotid string) *Reve return p } -// Revert VM from a vmsnapshot. +// Revert Instance from a vmsnapshot. func (s *SnapshotService) RevertToVMSnapshot(p *RevertToVMSnapshotParams) (*RevertToVMSnapshotResponse, error) { resp, err := s.cs.newPostRequest("revertToVMSnapshot", p.toURLValues()) if err != nil { @@ -3748,6 +3760,7 @@ func (s *SnapshotService) RevertToVMSnapshot(p *RevertToVMSnapshotParams) (*Reve type RevertToVMSnapshotResponse struct { Account string `json:"account"` Affinitygroup []RevertToVMSnapshotResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -4019,7 +4032,7 @@ func (s *SnapshotService) NewUpdateSnapshotPolicyParams() *UpdateSnapshotPolicyP return p } -// Updates the snapshot policy. +// Updates the Snapshot policy. func (s *SnapshotService) UpdateSnapshotPolicy(p *UpdateSnapshotPolicyParams) (*UpdateSnapshotPolicyResponse, error) { resp, err := s.cs.newPostRequest("updateSnapshotPolicy", p.toURLValues()) if err != nil { diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index f024d06..c9e573b 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -257,7 +257,7 @@ func (s *SystemVMService) NewDestroySystemVmParams(id string) *DestroySystemVmPa return p } -// Destroys a system virtual machine. +// Destroys a System VM. func (s *SystemVMService) DestroySystemVm(p *DestroySystemVmParams) (*DestroySystemVmResponse, error) { resp, err := s.cs.newPostRequest("destroySystemVm", p.toURLValues()) if err != nil { @@ -729,7 +729,7 @@ func (s *SystemVMService) GetSystemVmByID(id string, opts ...OptionFunc) (*Syste return nil, l.Count, fmt.Errorf("There is more then one result for SystemVm UUID: %s!", id) } -// List system virtual machines. +// List System VMs. func (s *SystemVMService) ListSystemVms(p *ListSystemVmsParams) (*ListSystemVmsResponse, error) { resp, err := s.cs.newRequest("listSystemVms", p.toURLValues()) if err != nil { @@ -1255,7 +1255,7 @@ func (s *SystemVMService) NewMigrateSystemVmParams(virtualmachineid string) *Mig return p } -// Attempts Migration of a system virtual machine to the host specified. +// Attempts Migration of a System VM to the host specified. func (s *SystemVMService) MigrateSystemVm(p *MigrateSystemVmParams) (*MigrateSystemVmResponse, error) { resp, err := s.cs.newPostRequest("migrateSystemVm", p.toURLValues()) if err != nil { @@ -1704,7 +1704,7 @@ func (s *SystemVMService) NewStartSystemVmParams(id string) *StartSystemVmParams return p } -// Starts a system virtual machine. +// Starts a System VM. func (s *SystemVMService) StartSystemVm(p *StartSystemVmParams) (*StartSystemVmResponse, error) { resp, err := s.cs.newPostRequest("startSystemVm", p.toURLValues()) if err != nil { diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index e9f9071..2ebdd86 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -178,7 +178,7 @@ func (s *TemplateService) NewCopyTemplateParams(id string) *CopyTemplateParams { return p } -// Copies a template from one zone to another. +// Copies a Template from one zone to another. func (s *TemplateService) CopyTemplate(p *CopyTemplateParams) (*CopyTemplateResponse, error) { resp, err := s.cs.newPostRequest("copyTemplate", p.toURLValues()) if err != nil { @@ -839,7 +839,7 @@ func (s *TemplateService) NewCreateTemplateParams(displaytext string, name strin return p } -// 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. +// Creates a Template of an Instance. The Instance 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. func (s *TemplateService) CreateTemplate(p *CreateTemplateParams) (*CreateTemplateResponse, error) { resp, err := s.cs.newPostRequest("createTemplate", p.toURLValues()) if err != nil { @@ -1082,7 +1082,7 @@ func (s *TemplateService) NewDeleteTemplateParams(id string) *DeleteTemplatePara return p } -// Deletes a template from the system. All virtual machines using the deleted template will not be affected. +// Deletes a Template from the system. All Instances using the deleted Template will not be affected. func (s *TemplateService) DeleteTemplate(p *DeleteTemplateParams) (*DeleteTemplateResponse, error) { resp, err := s.cs.newPostRequest("deleteTemplate", p.toURLValues()) if err != nil { @@ -1237,7 +1237,7 @@ func (s *TemplateService) NewExtractTemplateParams(id string, mode string) *Extr return p } -// Extracts a template +// Extracts a Template func (s *TemplateService) ExtractTemplate(p *ExtractTemplateParams) (*ExtractTemplateResponse, error) { resp, err := s.cs.newPostRequest("extractTemplate", p.toURLValues()) if err != nil { @@ -1930,7 +1930,7 @@ func (s *TemplateService) NewGetUploadParamsForTemplateParams(displaytext string return p } -// upload an existing template into the CloudStack cloud. +// Upload an existing Template into the CloudStack cloud. func (s *TemplateService) GetUploadParamsForTemplate(p *GetUploadParamsForTemplateParams) (*GetUploadParamsForTemplateResponse, error) { resp, err := s.cs.newRequest("getUploadParamsForTemplate", p.toURLValues()) if err != nil { @@ -2036,7 +2036,7 @@ func (s *TemplateService) GetTemplatePermissionByID(id string, opts ...OptionFun return nil, l.Count, fmt.Errorf("There is more then one result for TemplatePermission UUID: %s!", id) } -// List template visibility and all accounts that have permissions to view this template. +// List Template visibility and all accounts that have permissions to view this Template. func (s *TemplateService) ListTemplatePermissions(p *ListTemplatePermissionsParams) (*ListTemplatePermissionsResponse, error) { resp, err := s.cs.newRequest("listTemplatePermissions", p.toURLValues()) if err != nil { @@ -2885,7 +2885,7 @@ func (s *TemplateService) GetTemplateByID(id string, templatefilter string, opts return nil, l.Count, fmt.Errorf("There is more then one result for Template UUID: %s!", id) } -// List all public, private, and privileged templates. +// List all public, private, and privileged Templates. func (s *TemplateService) ListTemplates(p *ListTemplatesParams) (*ListTemplatesResponse, error) { resp, err := s.cs.newRequest("listTemplates", p.toURLValues()) if err != nil { @@ -3088,7 +3088,7 @@ func (s *TemplateService) NewPrepareTemplateParams(templateid string, zoneid str return p } -// load template into primary storage +// Load Template into primary storage func (s *TemplateService) PrepareTemplate(p *PrepareTemplateParams) (*PrepareTemplateResponse, error) { resp, err := s.cs.newPostRequest("prepareTemplate", p.toURLValues()) if err != nil { @@ -3956,7 +3956,7 @@ func (s *TemplateService) NewRegisterTemplateParams(displaytext string, format s return p } -// Registers an existing template into the CloudStack cloud. +// Registers an existing Template into the CloudStack cloud. func (s *TemplateService) RegisterTemplate(p *RegisterTemplateParams) (*RegisterTemplateResponse, error) { resp, err := s.cs.newPostRequest("registerTemplate", p.toURLValues()) if err != nil { @@ -4555,7 +4555,7 @@ func (s *TemplateService) NewUpdateTemplateParams(id string) *UpdateTemplatePara return p } -// Updates attributes of a template. +// Updates attributes of a Template. func (s *TemplateService) UpdateTemplate(p *UpdateTemplateParams) (*UpdateTemplateResponse, error) { resp, err := s.cs.newPostRequest("updateTemplate", p.toURLValues()) if err != nil { @@ -4853,7 +4853,7 @@ func (s *TemplateService) NewUpdateTemplatePermissionsParams(id string) *UpdateT return p } -// Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. +// Updates a Template visibility permissions. A public Template is visible to all accounts within the same domain. A private Template is visible only to the owner of the Template. A privileged Template is a private Template with account permissions added. Only accounts specified under the Template permissions are visible to them. func (s *TemplateService) UpdateTemplatePermissions(p *UpdateTemplatePermissionsParams) (*UpdateTemplatePermissionsResponse, error) { resp, err := s.cs.newPostRequest("updateTemplatePermissions", p.toURLValues()) if err != nil { @@ -5066,7 +5066,7 @@ func (s *TemplateService) NewUpgradeRouterTemplateParams() *UpgradeRouterTemplat return p } -// Upgrades router to use newer template +// Upgrades router to use newer Template func (s *TemplateService) UpgradeRouterTemplate(p *UpgradeRouterTemplateParams) (*UpgradeRouterTemplateResponse, error) { resp, err := s.cs.newPostRequest("upgradeRouterTemplate", p.toURLValues()) if err != nil { @@ -5202,7 +5202,7 @@ func (s *TemplateService) NewLinkUserDataToTemplateParams() *LinkUserDataToTempl return p } -// Link or unlink a userdata to a template. +// Link or unlink a userdata to a Template. func (s *TemplateService) LinkUserDataToTemplate(p *LinkUserDataToTemplateParams) (*LinkUserDataToTemplateResponse, error) { resp, err := s.cs.newPostRequest("linkUserDataToTemplate", p.toURLValues()) if err != nil { diff --git a/cloudstack/UCSService.go b/cloudstack/UCSService.go index 0cbbd3d..65896d2 100644 --- a/cloudstack/UCSService.go +++ b/cloudstack/UCSService.go @@ -308,7 +308,7 @@ func (s *UCSService) NewAssociateUcsProfileToBladeParams(bladeid string, profile return p } -// associate a profile to a blade +// Associate a profile to a blade func (s *UCSService) AssociateUcsProfileToBlade(p *AssociateUcsProfileToBladeParams) (*AssociateUcsProfileToBladeResponse, error) { resp, err := s.cs.newPostRequest("associateUcsProfileToBlade", p.toURLValues()) if err != nil { diff --git a/cloudstack/UserService.go b/cloudstack/UserService.go index 1b46c0b..10fc217 100644 --- a/cloudstack/UserService.go +++ b/cloudstack/UserService.go @@ -868,7 +868,7 @@ func (s *UserService) NewGetVirtualMachineUserDataParams(virtualmachineid string return p } -// Returns user data associated with the VM +// Returns user data associated with the Instance func (s *UserService) GetVirtualMachineUserData(p *GetVirtualMachineUserDataParams) (*GetVirtualMachineUserDataResponse, error) { resp, err := s.cs.newRequest("getVirtualMachineUserData", p.toURLValues()) if err != nil { diff --git a/cloudstack/VMGroupService.go b/cloudstack/VMGroupService.go index c64a179..0f5e74c 100644 --- a/cloudstack/VMGroupService.go +++ b/cloudstack/VMGroupService.go @@ -158,7 +158,7 @@ func (s *VMGroupService) NewCreateInstanceGroupParams(name string) *CreateInstan return p } -// Creates a vm group +// Creates an Instance group func (s *VMGroupService) CreateInstanceGroup(p *CreateInstanceGroupParams) (*CreateInstanceGroupResponse, error) { resp, err := s.cs.newPostRequest("createInstanceGroup", p.toURLValues()) if err != nil { @@ -233,7 +233,7 @@ func (s *VMGroupService) NewDeleteInstanceGroupParams(id string) *DeleteInstance return p } -// Deletes a vm group +// Deletes an Instance group func (s *VMGroupService) DeleteInstanceGroup(p *DeleteInstanceGroupParams) (*DeleteInstanceGroupResponse, error) { resp, err := s.cs.newPostRequest("deleteInstanceGroup", p.toURLValues()) if err != nil { @@ -629,7 +629,7 @@ func (s *VMGroupService) GetInstanceGroupByID(id string, opts ...OptionFunc) (*I return nil, l.Count, fmt.Errorf("There is more then one result for InstanceGroup UUID: %s!", id) } -// Lists vm groups +// Lists Instance groups func (s *VMGroupService) ListInstanceGroups(p *ListInstanceGroupsParams) (*ListInstanceGroupsResponse, error) { resp, err := s.cs.newRequest("listInstanceGroups", p.toURLValues()) if err != nil { @@ -733,7 +733,7 @@ func (s *VMGroupService) NewUpdateInstanceGroupParams(id string) *UpdateInstance return p } -// Updates a vm group +// Updates an Instance group func (s *VMGroupService) UpdateInstanceGroup(p *UpdateInstanceGroupParams) (*UpdateInstanceGroupResponse, error) { resp, err := s.cs.newPostRequest("updateInstanceGroup", p.toURLValues()) if err != nil { diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index d5f67d0..59fe105 100644 --- a/cloudstack/VPCService.go +++ b/cloudstack/VPCService.go @@ -4127,7 +4127,7 @@ func (s *VPCService) NewMigrateVPCParams(vpcid string, vpcofferingid string) *Mi return p } -// moves a vpc to another physical network +// Moves a VPC to another physical network func (s *VPCService) MigrateVPC(p *MigrateVPCParams) (*MigrateVPCResponse, error) { resp, err := s.cs.newPostRequest("migrateVPC", p.toURLValues()) if err != nil { diff --git a/cloudstack/VPNService.go b/cloudstack/VPNService.go index 785c1cd..056b594 100644 --- a/cloudstack/VPNService.go +++ b/cloudstack/VPNService.go @@ -219,7 +219,7 @@ func (s *VPNService) NewAddVpnUserParams(password string, username string) *AddV return p } -// Adds vpn users +// Adds VPN Users func (s *VPNService) AddVpnUser(p *AddVpnUserParams) (*AddVpnUserResponse, error) { resp, err := s.cs.newPostRequest("addVpnUser", p.toURLValues()) if err != nil { @@ -435,7 +435,7 @@ func (s *VPNService) NewCreateRemoteAccessVpnParams(publicipid string) *CreateRe return p } -// Creates a l2tp/ipsec remote access vpn +// Creates a l2tp/ipsec remote access VPN func (s *VPNService) CreateRemoteAccessVpn(p *CreateRemoteAccessVpnParams) (*CreateRemoteAccessVpnResponse, error) { resp, err := s.cs.newPostRequest("createRemoteAccessVpn", p.toURLValues()) if err != nil { @@ -608,7 +608,7 @@ func (s *VPNService) NewCreateVpnConnectionParams(s2scustomergatewayid string, s return p } -// Create site to site vpn connection +// Create site to site VPN connection func (s *VPNService) CreateVpnConnection(p *CreateVpnConnectionParams) (*CreateVpnConnectionResponse, error) { resp, err := s.cs.newPostRequest("createVpnConnection", p.toURLValues()) if err != nil { @@ -1064,7 +1064,7 @@ func (s *VPNService) NewCreateVpnCustomerGatewayParams(cidrlist string, esppolic return p } -// Creates site to site vpn customer gateway +// Creates site to site VPN customer gateway func (s *VPNService) CreateVpnCustomerGateway(p *CreateVpnCustomerGatewayParams) (*CreateVpnCustomerGatewayResponse, error) { resp, err := s.cs.newPostRequest("createVpnCustomerGateway", p.toURLValues()) if err != nil { @@ -1220,7 +1220,7 @@ func (s *VPNService) NewCreateVpnGatewayParams(vpcid string) *CreateVpnGatewayPa return p } -// Creates site to site vpn local gateway +// Creates site to site VPN local gateway func (s *VPNService) CreateVpnGateway(p *CreateVpnGatewayParams) (*CreateVpnGatewayResponse, error) { resp, err := s.cs.newPostRequest("createVpnGateway", p.toURLValues()) if err != nil { @@ -1317,7 +1317,7 @@ func (s *VPNService) NewDeleteRemoteAccessVpnParams(publicipid string) *DeleteRe return p } -// Destroys a l2tp/ipsec remote access vpn +// Destroys a l2tp/ipsec remote access VPN func (s *VPNService) DeleteRemoteAccessVpn(p *DeleteRemoteAccessVpnParams) (*DeleteRemoteAccessVpnResponse, error) { resp, err := s.cs.newPostRequest("deleteRemoteAccessVpn", p.toURLValues()) if err != nil { @@ -1399,7 +1399,7 @@ func (s *VPNService) NewDeleteVpnConnectionParams(id string) *DeleteVpnConnectio return p } -// Delete site to site vpn connection +// Delete site to site VPN connection func (s *VPNService) DeleteVpnConnection(p *DeleteVpnConnectionParams) (*DeleteVpnConnectionResponse, error) { resp, err := s.cs.newPostRequest("deleteVpnConnection", p.toURLValues()) if err != nil { @@ -1481,7 +1481,7 @@ func (s *VPNService) NewDeleteVpnCustomerGatewayParams(id string) *DeleteVpnCust return p } -// Delete site to site vpn customer gateway +// Delete site to site VPN customer gateway func (s *VPNService) DeleteVpnCustomerGateway(p *DeleteVpnCustomerGatewayParams) (*DeleteVpnCustomerGatewayResponse, error) { resp, err := s.cs.newPostRequest("deleteVpnCustomerGateway", p.toURLValues()) if err != nil { @@ -1563,7 +1563,7 @@ func (s *VPNService) NewDeleteVpnGatewayParams(id string) *DeleteVpnGatewayParam return p } -// Delete site to site vpn gateway +// Delete site to site VPN gateway func (s *VPNService) DeleteVpnGateway(p *DeleteVpnGatewayParams) (*DeleteVpnGatewayResponse, error) { resp, err := s.cs.newPostRequest("deleteVpnGateway", p.toURLValues()) if err != nil { @@ -1946,7 +1946,7 @@ func (s *VPNService) GetRemoteAccessVpnByID(id string, opts ...OptionFunc) (*Rem return nil, l.Count, fmt.Errorf("There is more then one result for RemoteAccessVpn UUID: %s!", id) } -// Lists remote access vpns +// Lists remote access VPNs func (s *VPNService) ListRemoteAccessVpns(p *ListRemoteAccessVpnsParams) (*ListRemoteAccessVpnsResponse, error) { resp, err := s.cs.newRequest("listRemoteAccessVpns", p.toURLValues()) if err != nil { @@ -2306,7 +2306,7 @@ func (s *VPNService) GetVpnConnectionByID(id string, opts ...OptionFunc) (*VpnCo return nil, l.Count, fmt.Errorf("There is more then one result for VpnConnection UUID: %s!", id) } -// Lists site to site vpn connection gateways +// Lists site to site VPN connection gateways func (s *VPNService) ListVpnConnections(p *ListVpnConnectionsParams) (*ListVpnConnectionsResponse, error) { resp, err := s.cs.newRequest("listVpnConnections", p.toURLValues()) if err != nil { @@ -2680,7 +2680,7 @@ func (s *VPNService) GetVpnCustomerGatewayByID(id string, opts ...OptionFunc) (* return nil, l.Count, fmt.Errorf("There is more then one result for VpnCustomerGateway UUID: %s!", id) } -// Lists site to site vpn customer gateways +// Lists site to site VPN customer gateways func (s *VPNService) ListVpnCustomerGateways(p *ListVpnCustomerGatewaysParams) (*ListVpnCustomerGatewaysResponse, error) { resp, err := s.cs.newRequest("listVpnCustomerGateways", p.toURLValues()) if err != nil { @@ -3049,7 +3049,7 @@ func (s *VPNService) GetVpnGatewayByID(id string, opts ...OptionFunc) (*VpnGatew return nil, l.Count, fmt.Errorf("There is more then one result for VpnGateway UUID: %s!", id) } -// Lists site 2 site vpn gateways +// Lists site 2 site VPN gateways func (s *VPNService) ListVpnGateways(p *ListVpnGatewaysParams) (*ListVpnGatewaysResponse, error) { resp, err := s.cs.newRequest("listVpnGateways", p.toURLValues()) if err != nil { @@ -3383,7 +3383,7 @@ func (s *VPNService) GetVpnUserByID(id string, opts ...OptionFunc) (*VpnUser, in return nil, l.Count, fmt.Errorf("There is more then one result for VpnUser UUID: %s!", id) } -// Lists vpn users +// Lists VPN Users func (s *VPNService) ListVpnUsers(p *ListVpnUsersParams) (*ListVpnUsersResponse, error) { resp, err := s.cs.newRequest("listVpnUsers", p.toURLValues()) if err != nil { @@ -3534,7 +3534,7 @@ func (s *VPNService) NewRemoveVpnUserParams(username string) *RemoveVpnUserParam return p } -// Removes vpn user +// Removes VPN User func (s *VPNService) RemoveVpnUser(p *RemoveVpnUserParams) (*RemoveVpnUserResponse, error) { resp, err := s.cs.newPostRequest("removeVpnUser", p.toURLValues()) if err != nil { @@ -3664,7 +3664,7 @@ func (s *VPNService) NewResetVpnConnectionParams(id string) *ResetVpnConnectionP return p } -// Reset site to site vpn connection +// Reset site to site VPN connection func (s *VPNService) ResetVpnConnection(p *ResetVpnConnectionParams) (*ResetVpnConnectionResponse, error) { resp, err := s.cs.newPostRequest("resetVpnConnection", p.toURLValues()) if err != nil { @@ -3824,7 +3824,7 @@ func (s *VPNService) NewUpdateRemoteAccessVpnParams(id string) *UpdateRemoteAcce return p } -// Updates remote access vpn +// Updates remote access VPN func (s *VPNService) UpdateRemoteAccessVpn(p *UpdateRemoteAccessVpnParams) (*UpdateRemoteAccessVpnResponse, error) { resp, err := s.cs.newPostRequest("updateRemoteAccessVpn", p.toURLValues()) if err != nil { @@ -3971,7 +3971,7 @@ func (s *VPNService) NewUpdateVpnConnectionParams(id string) *UpdateVpnConnectio return p } -// Updates site to site vpn connection +// Updates site to site VPN connection func (s *VPNService) UpdateVpnConnection(p *UpdateVpnConnectionParams) (*UpdateVpnConnectionResponse, error) { resp, err := s.cs.newPostRequest("updateVpnConnection", p.toURLValues()) if err != nil { @@ -4428,7 +4428,7 @@ func (s *VPNService) NewUpdateVpnCustomerGatewayParams(cidrlist string, esppolic return p } -// Update site to site vpn customer gateway +// Update site to site VPN customer gateway func (s *VPNService) UpdateVpnCustomerGateway(p *UpdateVpnCustomerGatewayParams) (*UpdateVpnCustomerGatewayResponse, error) { resp, err := s.cs.newPostRequest("updateVpnCustomerGateway", p.toURLValues()) if err != nil { @@ -4584,7 +4584,7 @@ func (s *VPNService) NewUpdateVpnGatewayParams(id string) *UpdateVpnGatewayParam return p } -// Updates site to site vpn local gateway +// Updates site to site VPN local gateway func (s *VPNService) UpdateVpnGateway(p *UpdateVpnGatewayParams) (*UpdateVpnGatewayResponse, error) { resp, err := s.cs.newPostRequest("updateVpnGateway", p.toURLValues()) if err != nil { diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 675b5c8..4d0fdcb 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -258,7 +258,7 @@ func (s *VirtualMachineService) NewAddNicToVirtualMachineParams(networkid string return p } -// Adds VM to specified network by creating a NIC +// Adds Instance to specified network by creating a NIC func (s *VirtualMachineService) AddNicToVirtualMachine(p *AddNicToVirtualMachineParams) (*AddNicToVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("addNicToVirtualMachine", p.toURLValues()) if err != nil { @@ -296,6 +296,7 @@ func (s *VirtualMachineService) AddNicToVirtualMachine(p *AddNicToVirtualMachine type AddNicToVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AddNicToVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -641,7 +642,7 @@ func (s *VirtualMachineService) NewAssignVirtualMachineParams(virtualmachineid s return p } -// Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. +// Change ownership of an Instance from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign an Instance from any account to any other account in any domain. A domain administrator can reassign an Instance to any account in the same domain. func (s *VirtualMachineService) AssignVirtualMachine(p *AssignVirtualMachineParams) (*AssignVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("assignVirtualMachine", p.toURLValues()) if err != nil { @@ -659,6 +660,7 @@ func (s *VirtualMachineService) AssignVirtualMachine(p *AssignVirtualMachinePara type AssignVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AssignVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -1034,7 +1036,7 @@ func (s *VirtualMachineService) NewChangeServiceForVirtualMachineParams(id strin return p } -// (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. +// (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for an Instance. The Instance must be in a "Stopped" state for this command to take effect. func (s *VirtualMachineService) ChangeServiceForVirtualMachine(p *ChangeServiceForVirtualMachineParams) (*ChangeServiceForVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("changeServiceForVirtualMachine", p.toURLValues()) if err != nil { @@ -1052,6 +1054,7 @@ func (s *VirtualMachineService) ChangeServiceForVirtualMachine(p *ChangeServiceF type ChangeServiceForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ChangeServiceForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -1250,7 +1253,7 @@ func (s *VirtualMachineService) NewCleanVMReservationsParams() *CleanVMReservati return p } -// Cleanups VM reservations in the database. +// Cleanups Instance reservations in the database. func (s *VirtualMachineService) CleanVMReservations(p *CleanVMReservationsParams) (*CleanVMReservationsResponse, error) { resp, err := s.cs.newPostRequest("cleanVMReservations", p.toURLValues()) if err != nil { @@ -2798,7 +2801,7 @@ func (s *VirtualMachineService) NewDeployVirtualMachineParams(serviceofferingid return p } -// Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. +// Creates and automatically starts an Instance based on a service offering, disk offering, and Template. func (s *VirtualMachineService) DeployVirtualMachine(p *DeployVirtualMachineParams) (*DeployVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("deployVirtualMachine", p.toURLValues()) if err != nil { @@ -2836,6 +2839,7 @@ func (s *VirtualMachineService) DeployVirtualMachine(p *DeployVirtualMachinePara type DeployVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DeployVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -3109,7 +3113,7 @@ func (s *VirtualMachineService) NewDestroyVirtualMachineParams(id string) *Destr return p } -// Destroys a virtual machine. Once destroyed, only the administrator can recover it. +// Destroys an Instance. Once destroyed, only the administrator can recover it. func (s *VirtualMachineService) DestroyVirtualMachine(p *DestroyVirtualMachineParams) (*DestroyVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("destroyVirtualMachine", p.toURLValues()) if err != nil { @@ -3147,6 +3151,7 @@ func (s *VirtualMachineService) DestroyVirtualMachine(p *DestroyVirtualMachinePa type DestroyVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DestroyVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -3370,7 +3375,7 @@ func (s *VirtualMachineService) NewExpungeVirtualMachineParams(id string) *Expun return p } -// Expunge a virtual machine. Once expunged, it cannot be recoverd. +// Expunge an Instance. Once expunged, it cannot be recovered. func (s *VirtualMachineService) ExpungeVirtualMachine(p *ExpungeVirtualMachineParams) (*ExpungeVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("expungeVirtualMachine", p.toURLValues()) if err != nil { @@ -3452,7 +3457,7 @@ func (s *VirtualMachineService) NewGetVMPasswordParams(id string) *GetVMPassword return p } -// Returns an encrypted password for the VM +// Returns an encrypted password for the Instance func (s *VirtualMachineService) GetVMPassword(p *GetVMPasswordParams) (*GetVMPasswordResponse, error) { resp, err := s.cs.newRequest("getVMPassword", p.toURLValues()) if err != nil { @@ -4676,7 +4681,7 @@ func (s *VirtualMachineService) GetVirtualMachineByID(id string, opts ...OptionF return nil, l.Count, fmt.Errorf("There is more then one result for VirtualMachine UUID: %s!", id) } -// List the virtual machines owned by the account. +// List the Instances owned by the account. func (s *VirtualMachineService) ListVirtualMachines(p *ListVirtualMachinesParams) (*ListVirtualMachinesResponse, error) { resp, err := s.cs.newRequest("listVirtualMachines", p.toURLValues()) if err != nil { @@ -4699,6 +4704,7 @@ type ListVirtualMachinesResponse struct { type VirtualMachine struct { Account string `json:"account"` Affinitygroup []VirtualMachineAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -6103,6 +6109,7 @@ type ListVirtualMachinesMetricsResponse struct { type VirtualMachinesMetric struct { Account string `json:"account"` Affinitygroup []VirtualMachinesMetricAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -6526,24 +6533,26 @@ type ListVmsForImportResponse struct { } type VmsForImport struct { - Bootmode string `json:"bootmode"` - Boottype string `json:"boottype"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Cpucorepersocket int `json:"cpucorepersocket"` - Cpunumber int `json:"cpunumber"` - Cpuspeed int `json:"cpuspeed"` - Disk []VmsForImportDisk `json:"disk"` - Hostid string `json:"hostid"` - Hostname string `json:"hostname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Memory int `json:"memory"` - Name string `json:"name"` - Nic []Nic `json:"nic"` - Osdisplayname string `json:"osdisplayname"` - Osid string `json:"osid"` - Powerstate string `json:"powerstate"` + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Cpucorepersocket int `json:"cpucorepersocket"` + Cpunumber int `json:"cpunumber"` + Cpuspeed int `json:"cpuspeed"` + Disk []VmsForImportDisk `json:"disk"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Hypervisor string `json:"hypervisor"` + Hypervisorversion string `json:"hypervisorversion"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Memory int `json:"memory"` + Name string `json:"name"` + Nic []Nic `json:"nic"` + Osdisplayname string `json:"osdisplayname"` + Osid string `json:"osid"` + Powerstate string `json:"powerstate"` } type VmsForImportDisk struct { @@ -6678,7 +6687,7 @@ func (s *VirtualMachineService) NewMigrateVirtualMachineParams(virtualmachineid return p } -// Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool +// Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool func (s *VirtualMachineService) MigrateVirtualMachine(p *MigrateVirtualMachineParams) (*MigrateVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("migrateVirtualMachine", p.toURLValues()) if err != nil { @@ -6716,6 +6725,7 @@ func (s *VirtualMachineService) MigrateVirtualMachine(p *MigrateVirtualMachinePa type MigrateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -7031,7 +7041,7 @@ func (s *VirtualMachineService) NewMigrateVirtualMachineWithVolumeParams(virtual return p } -// Attempts Migration of a VM with its volumes to a different host +// Attempts Migration of an Instance with its volumes to a different host func (s *VirtualMachineService) MigrateVirtualMachineWithVolume(p *MigrateVirtualMachineWithVolumeParams) (*MigrateVirtualMachineWithVolumeResponse, error) { resp, err := s.cs.newPostRequest("migrateVirtualMachineWithVolume", p.toURLValues()) if err != nil { @@ -7069,6 +7079,7 @@ func (s *VirtualMachineService) MigrateVirtualMachineWithVolume(p *MigrateVirtua type MigrateVirtualMachineWithVolumeResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineWithVolumeResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -7342,7 +7353,7 @@ func (s *VirtualMachineService) NewRebootVirtualMachineParams(id string) *Reboot return p } -// Reboots a virtual machine. +// Reboots an Instance. func (s *VirtualMachineService) RebootVirtualMachine(p *RebootVirtualMachineParams) (*RebootVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("rebootVirtualMachine", p.toURLValues()) if err != nil { @@ -7380,6 +7391,7 @@ func (s *VirtualMachineService) RebootVirtualMachine(p *RebootVirtualMachinePara type RebootVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RebootVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -7603,7 +7615,7 @@ func (s *VirtualMachineService) NewRecoverVirtualMachineParams(id string) *Recov return p } -// Recovers a virtual machine. +// Recovers an Instance. func (s *VirtualMachineService) RecoverVirtualMachine(p *RecoverVirtualMachineParams) (*RecoverVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("recoverVirtualMachine", p.toURLValues()) if err != nil { @@ -7621,6 +7633,7 @@ func (s *VirtualMachineService) RecoverVirtualMachine(p *RecoverVirtualMachinePa type RecoverVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RecoverVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -7869,7 +7882,7 @@ func (s *VirtualMachineService) NewRemoveNicFromVirtualMachineParams(nicid strin return p } -// Removes VM from specified network by deleting a NIC +// Removes Instance from specified network by deleting a NIC func (s *VirtualMachineService) RemoveNicFromVirtualMachine(p *RemoveNicFromVirtualMachineParams) (*RemoveNicFromVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("removeNicFromVirtualMachine", p.toURLValues()) if err != nil { @@ -7907,6 +7920,7 @@ func (s *VirtualMachineService) RemoveNicFromVirtualMachine(p *RemoveNicFromVirt type RemoveNicFromVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RemoveNicFromVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -8154,7 +8168,7 @@ func (s *VirtualMachineService) NewResetPasswordForVirtualMachineParams(id strin return p } -// 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] +// Resets the password for Instance. The Instance must be in a "Stopped" state and the Template must already support this feature for this command to take effect. [async] func (s *VirtualMachineService) ResetPasswordForVirtualMachine(p *ResetPasswordForVirtualMachineParams) (*ResetPasswordForVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("resetPasswordForVirtualMachine", p.toURLValues()) if err != nil { @@ -8192,6 +8206,7 @@ func (s *VirtualMachineService) ResetPasswordForVirtualMachine(p *ResetPasswordF type ResetPasswordForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetPasswordForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -8562,7 +8577,7 @@ func (s *VirtualMachineService) NewResetUserDataForVirtualMachineParams(id strin return p } -// Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. +// Resets the UserData for Instance. The Instance must be in a "Stopped" state. func (s *VirtualMachineService) ResetUserDataForVirtualMachine(p *ResetUserDataForVirtualMachineParams) (*ResetUserDataForVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("resetUserDataForVirtualMachine", p.toURLValues()) if err != nil { @@ -8580,6 +8595,7 @@ func (s *VirtualMachineService) ResetUserDataForVirtualMachine(p *ResetUserDataF type ResetUserDataForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetUserDataForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -8928,7 +8944,7 @@ func (s *VirtualMachineService) NewRestoreVirtualMachineParams(virtualmachineid return p } -// Restore a VM to original template/ISO or new template/ISO +// Restore an Instance to original Template/ISO or new Template/ISO func (s *VirtualMachineService) RestoreVirtualMachine(p *RestoreVirtualMachineParams) (*RestoreVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("restoreVirtualMachine", p.toURLValues()) if err != nil { @@ -8966,6 +8982,7 @@ func (s *VirtualMachineService) RestoreVirtualMachine(p *RestoreVirtualMachinePa type RestoreVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RestoreVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -9341,7 +9358,7 @@ func (s *VirtualMachineService) NewScaleVirtualMachineParams(id string, serviceo return p } -// Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. +// Scales the Instance to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. func (s *VirtualMachineService) ScaleVirtualMachine(p *ScaleVirtualMachineParams) (*ScaleVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("scaleVirtualMachine", p.toURLValues()) if err != nil { @@ -9569,7 +9586,7 @@ func (s *VirtualMachineService) NewStartVirtualMachineParams(id string) *StartVi return p } -// Starts a virtual machine. +// Starts an Instance. func (s *VirtualMachineService) StartVirtualMachine(p *StartVirtualMachineParams) (*StartVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("startVirtualMachine", p.toURLValues()) if err != nil { @@ -9607,6 +9624,7 @@ func (s *VirtualMachineService) StartVirtualMachine(p *StartVirtualMachineParams type StartVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StartVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -9855,7 +9873,7 @@ func (s *VirtualMachineService) NewStopVirtualMachineParams(id string) *StopVirt return p } -// Stops a virtual machine. +// Stops an Instance. func (s *VirtualMachineService) StopVirtualMachine(p *StopVirtualMachineParams) (*StopVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("stopVirtualMachine", p.toURLValues()) if err != nil { @@ -9893,6 +9911,7 @@ func (s *VirtualMachineService) StopVirtualMachine(p *StopVirtualMachineParams) type StopVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StopVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -10141,7 +10160,7 @@ func (s *VirtualMachineService) NewUpdateDefaultNicForVirtualMachineParams(nicid return p } -// Changes the default NIC on a VM +// Changes the default NIC on an Instance func (s *VirtualMachineService) UpdateDefaultNicForVirtualMachine(p *UpdateDefaultNicForVirtualMachineParams) (*UpdateDefaultNicForVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("updateDefaultNicForVirtualMachine", p.toURLValues()) if err != nil { @@ -10179,6 +10198,7 @@ func (s *VirtualMachineService) UpdateDefaultNicForVirtualMachine(p *UpdateDefau type UpdateDefaultNicForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateDefaultNicForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -10939,7 +10959,7 @@ func (s *VirtualMachineService) NewUpdateVirtualMachineParams(id string) *Update return p } -// 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. +// Updates properties of an Instance. The Instance has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. Therefore, stop the Instance manually before issuing this call. func (s *VirtualMachineService) UpdateVirtualMachine(p *UpdateVirtualMachineParams) (*UpdateVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("updateVirtualMachine", p.toURLValues()) if err != nil { @@ -10957,6 +10977,7 @@ func (s *VirtualMachineService) UpdateVirtualMachine(p *UpdateVirtualMachinePara type UpdateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -11593,6 +11614,9 @@ func (p *ImportVmParams) toURLValues() url.Values { u.Set(fmt.Sprintf("nicnetworklist[%d].network", i), m[k]) } } + if v, found := p.p["osid"]; found { + u.Set("osid", v.(string)) + } if v, found := p.p["password"]; found { u.Set("password", v.(string)) } @@ -11614,6 +11638,10 @@ func (p *ImportVmParams) toURLValues() url.Values { if v, found := p.p["username"]; found { u.Set("username", v.(string)) } + if v, found := p.p["usevddk"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("usevddk", vv) + } if v, found := p.p["vcenter"]; found { u.Set("vcenter", v.(string)) } @@ -12239,6 +12267,27 @@ func (p *ImportVmParams) GetNicnetworklist() (map[string]string, bool) { return value, ok } +func (p *ImportVmParams) SetOsid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["osid"] = v +} + +func (p *ImportVmParams) ResetOsid() { + if p.p != nil && p.p["osid"] != nil { + delete(p.p, "osid") + } +} + +func (p *ImportVmParams) GetOsid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["osid"].(string) + return value, ok +} + func (p *ImportVmParams) SetPassword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -12386,6 +12435,27 @@ func (p *ImportVmParams) GetUsername() (string, bool) { return value, ok } +func (p *ImportVmParams) SetUsevddk(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usevddk"] = v +} + +func (p *ImportVmParams) ResetUsevddk() { + if p.p != nil && p.p["usevddk"] != nil { + delete(p.p, "usevddk") + } +} + +func (p *ImportVmParams) GetUsevddk() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usevddk"].(bool) + return value, ok +} + func (p *ImportVmParams) SetVcenter(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -12480,6 +12550,7 @@ func (s *VirtualMachineService) ImportVm(p *ImportVmParams) (*ImportVmResponse, type ImportVmResponse struct { Account string `json:"account"` Affinitygroup []ImportVmResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -12752,7 +12823,7 @@ func (s *VirtualMachineService) NewUnmanageVirtualMachineParams(id string) *Unma return p } -// Unmanage a guest virtual machine. +// Unmanage a Guest Instance. func (s *VirtualMachineService) UnmanageVirtualMachine(p *UnmanageVirtualMachineParams) (*UnmanageVirtualMachineResponse, error) { resp, err := s.cs.newPostRequest("unmanageVirtualMachine", p.toURLValues()) if err != nil { @@ -12938,7 +13009,7 @@ func (s *VirtualMachineService) NewListUnmanagedInstancesParams(clusterid string return p } -// Lists unmanaged virtual machines for a given cluster. +// Lists unmanaged Instances for a given cluster. func (s *VirtualMachineService) ListUnmanagedInstances(p *ListUnmanagedInstancesParams) (*ListUnmanagedInstancesResponse, error) { resp, err := s.cs.newRequest("listUnmanagedInstances", p.toURLValues()) if err != nil { @@ -12959,24 +13030,26 @@ type ListUnmanagedInstancesResponse struct { } type UnmanagedInstance struct { - Bootmode string `json:"bootmode"` - Boottype string `json:"boottype"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Cpucorepersocket int `json:"cpucorepersocket"` - Cpunumber int `json:"cpunumber"` - Cpuspeed int `json:"cpuspeed"` - Disk []UnmanagedInstanceDisk `json:"disk"` - Hostid string `json:"hostid"` - Hostname string `json:"hostname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Memory int `json:"memory"` - Name string `json:"name"` - Nic []Nic `json:"nic"` - Osdisplayname string `json:"osdisplayname"` - Osid string `json:"osid"` - Powerstate string `json:"powerstate"` + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Cpucorepersocket int `json:"cpucorepersocket"` + Cpunumber int `json:"cpunumber"` + Cpuspeed int `json:"cpuspeed"` + Disk []UnmanagedInstanceDisk `json:"disk"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Hypervisor string `json:"hypervisor"` + Hypervisorversion string `json:"hypervisorversion"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Memory int `json:"memory"` + Name string `json:"name"` + Nic []Nic `json:"nic"` + Osdisplayname string `json:"osdisplayname"` + Osid string `json:"osid"` + Powerstate string `json:"powerstate"` } type UnmanagedInstanceDisk struct { @@ -13393,7 +13466,7 @@ func (s *VirtualMachineService) NewImportUnmanagedInstanceParams(clusterid strin return p } -// Import unmanaged virtual machine from a given cluster. +// Import unmanaged Instance from a given cluster. func (s *VirtualMachineService) ImportUnmanagedInstance(p *ImportUnmanagedInstanceParams) (*ImportUnmanagedInstanceResponse, error) { resp, err := s.cs.newPostRequest("importUnmanagedInstance", p.toURLValues()) if err != nil { @@ -13431,6 +13504,7 @@ func (s *VirtualMachineService) ImportUnmanagedInstance(p *ImportUnmanagedInstan type ImportUnmanagedInstanceResponse struct { Account string `json:"account"` Affinitygroup []ImportUnmanagedInstanceResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -14085,7 +14159,7 @@ func (s *VirtualMachineService) NewCreateVMScheduleParams(action string, schedul return p } -// Create VM Schedule +// Create Instance Schedule func (s *VirtualMachineService) CreateVMSchedule(p *CreateVMScheduleParams) (*CreateVMScheduleResponse, error) { resp, err := s.cs.newPostRequest("createVMSchedule", p.toURLValues()) if err != nil { @@ -14308,7 +14382,7 @@ func (s *VirtualMachineService) NewUpdateVMScheduleParams(id string) *UpdateVMSc return p } -// Update VM Schedule. +// Update Instance Schedule. func (s *VirtualMachineService) UpdateVMSchedule(p *UpdateVMScheduleParams) (*UpdateVMScheduleResponse, error) { resp, err := s.cs.newPostRequest("updateVMSchedule", p.toURLValues()) if err != nil { @@ -14567,7 +14641,7 @@ func (s *VirtualMachineService) GetVMScheduleByID(id string, virtualmachineid st return nil, l.Count, fmt.Errorf("There is more then one result for VMSchedule UUID: %s!", id) } -// List VM Schedules. +// List Instance Schedules. func (s *VirtualMachineService) ListVMSchedule(p *ListVMScheduleParams) (*ListVMScheduleResponse, error) { resp, err := s.cs.newRequest("listVMSchedule", p.toURLValues()) if err != nil { @@ -14696,7 +14770,7 @@ func (s *VirtualMachineService) NewDeleteVMScheduleParams(virtualmachineid strin return p } -// Delete VM Schedule. +// Delete Instance Schedule. func (s *VirtualMachineService) DeleteVMSchedule(p *DeleteVMScheduleParams) (*DeleteVMScheduleResponse, error) { resp, err := s.cs.newPostRequest("deleteVMSchedule", p.toURLValues()) if err != nil { @@ -14815,7 +14889,7 @@ func (s *VirtualMachineService) NewAssignVirtualMachineToBackupOfferingParams(ba return p } -// Assigns a VM to a backup offering +// Assigns an Instance to a backup offering func (s *VirtualMachineService) AssignVirtualMachineToBackupOffering(p *AssignVirtualMachineToBackupOfferingParams) (*AssignVirtualMachineToBackupOfferingResponse, error) { resp, err := s.cs.newPostRequest("assignVirtualMachineToBackupOffering", p.toURLValues()) if err != nil { @@ -14922,7 +14996,7 @@ func (s *VirtualMachineService) NewRemoveVirtualMachineFromBackupOfferingParams( return p } -// Removes a VM from any existing backup offering +// Removes an Instance from any existing backup offering func (s *VirtualMachineService) RemoveVirtualMachineFromBackupOffering(p *RemoveVirtualMachineFromBackupOfferingParams) (*RemoveVirtualMachineFromBackupOfferingResponse, error) { resp, err := s.cs.newPostRequest("removeVirtualMachineFromBackupOffering", p.toURLValues()) if err != nil { diff --git a/cloudstack/VirtualNetworkFunctionsService.go b/cloudstack/VirtualNetworkFunctionsService.go index 90f7dee..c8f2a83 100644 --- a/cloudstack/VirtualNetworkFunctionsService.go +++ b/cloudstack/VirtualNetworkFunctionsService.go @@ -1709,6 +1709,7 @@ func (s *VirtualNetworkFunctionsService) DeployVnfAppliance(p *DeployVnfApplianc type DeployVnfApplianceResponse struct { Account string `json:"account"` Affinitygroup []DeployVnfApplianceResponseAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` @@ -3017,6 +3018,7 @@ type ListVnfAppliancesResponse struct { type VnfAppliance struct { Account string `json:"account"` Affinitygroup []VnfApplianceAffinitygroup `json:"affinitygroup"` + Alloweddetails string `json:"alloweddetails"` Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index c9158aa..386c72e 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -185,7 +185,7 @@ func (s *VolumeService) NewAttachVolumeParams(id string, virtualmachineid string return p } -// Attaches a disk volume to a virtual machine. +// Attaches a disk volume to an Instance. func (s *VolumeService) AttachVolume(p *AttachVolumeParams) (*AttachVolumeResponse, error) { resp, err := s.cs.newPostRequest("attachVolume", p.toURLValues()) if err != nil { @@ -828,6 +828,9 @@ func (p *CreateVolumeParams) toURLValues() url.Values { if v, found := p.p["snapshotid"]; found { u.Set("snapshotid", v.(string)) } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } if v, found := p.p["virtualmachineid"]; found { u.Set("virtualmachineid", v.(string)) } @@ -1068,6 +1071,27 @@ func (p *CreateVolumeParams) GetSnapshotid() (string, bool) { return value, ok } +func (p *CreateVolumeParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *CreateVolumeParams) ResetStorageid() { + if p.p != nil && p.p["storageid"] != nil { + delete(p.p, "storageid") + } +} + +func (p *CreateVolumeParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + func (p *CreateVolumeParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1118,7 +1142,7 @@ func (s *VolumeService) NewCreateVolumeParams() *CreateVolumeParams { return p } -// Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. +// Creates a disk volume from a disk offering. This disk volume must still be attached to an Instance to make use of it. func (s *VolumeService) CreateVolume(p *CreateVolumeParams) (*CreateVolumeResponse, error) { resp, err := s.cs.newPostRequest("createVolume", p.toURLValues()) if err != nil { @@ -1597,7 +1621,7 @@ func (s *VolumeService) NewDetachVolumeParams() *DetachVolumeParams { return p } -// Detaches a disk volume from a virtual machine. +// Detaches a disk volume from an Instance. func (s *VolumeService) DetachVolume(p *DetachVolumeParams) (*DetachVolumeResponse, error) { resp, err := s.cs.newPostRequest("detachVolume", p.toURLValues()) if err != nil { @@ -6443,7 +6467,7 @@ func (s *VolumeService) NewAssignVolumeParams(volumeid string) *AssignVolumePara return p } -// Changes ownership of a Volume from one account to another. +// Changes ownership of a Volume from one Account to another. func (s *VolumeService) AssignVolume(p *AssignVolumeParams) (*AssignVolumeResponse, error) { resp, err := s.cs.newPostRequest("assignVolume", p.toURLValues()) if err != nil { @@ -6632,7 +6656,7 @@ func (s *VolumeService) NewRestoreVolumeFromBackupAndAttachToVMParams(backupid s return p } -// Restore and attach a backed up volume to VM +// Restore and attach a backed up volume to Instance func (s *VolumeService) RestoreVolumeFromBackupAndAttachToVM(p *RestoreVolumeFromBackupAndAttachToVMParams) (*RestoreVolumeFromBackupAndAttachToVMResponse, error) { resp, err := s.cs.newPostRequest("restoreVolumeFromBackupAndAttachToVM", p.toURLValues()) if err != nil { diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index 8ae1e10..a9f0329 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -4129,24 +4129,26 @@ type ListVmwareDcVmsResponse struct { } type VmwareDcVm struct { - Bootmode string `json:"bootmode"` - Boottype string `json:"boottype"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Cpucorepersocket int `json:"cpucorepersocket"` - Cpunumber int `json:"cpunumber"` - Cpuspeed int `json:"cpuspeed"` - Disk []VmwareDcVmDisk `json:"disk"` - Hostid string `json:"hostid"` - Hostname string `json:"hostname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Memory int `json:"memory"` - Name string `json:"name"` - Nic []Nic `json:"nic"` - Osdisplayname string `json:"osdisplayname"` - Osid string `json:"osid"` - Powerstate string `json:"powerstate"` + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Cpucorepersocket int `json:"cpucorepersocket"` + Cpunumber int `json:"cpunumber"` + Cpuspeed int `json:"cpuspeed"` + Disk []VmwareDcVmDisk `json:"disk"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Hypervisor string `json:"hypervisor"` + Hypervisorversion string `json:"hypervisorversion"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Memory int `json:"memory"` + Name string `json:"name"` + Nic []Nic `json:"nic"` + Osdisplayname string `json:"osdisplayname"` + Osid string `json:"osid"` + Powerstate string `json:"powerstate"` } type VmwareDcVmDisk struct { diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index e16a934..59cb6b1 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -489,7 +489,9 @@ func (cs *CloudStackClient) GetAsyncJobResult(jobid string, timeout int64) (json currentTime := time.Now().Unix() for { - p := cs.Asyncjob.NewQueryAsyncJobResultParams(jobid) + p := &QueryAsyncJobResultParams{} + p.p = make(map[string]interface{}) + p.SetJobID(jobid) r, err := cs.Asyncjob.QueryAsyncJobResult(p) if err != nil { return nil, err diff --git a/generate/generate.go b/generate/generate.go index 448b614..982ce22 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -537,7 +537,9 @@ func (as *allServices) GeneralCode() ([]byte, error) { pn(" currentTime := time.Now().Unix()") pn("") pn(" for {") - pn(" p := cs.Asyncjob.NewQueryAsyncJobResultParams(jobid)") + pn(" p := &QueryAsyncJobResultParams{}") + pn(" p.p = make(map[string]interface{})") + pn(" p.SetJobID(jobid)") pn(" r, err := cs.Asyncjob.QueryAsyncJobResult(p)") pn(" if err != nil {") pn(" return nil, err") diff --git a/generate/listApis.json b/generate/listApis.json index a8c045f..a7652ec 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -6,74 +6,76 @@ "name": "createVPCOffering", "params": [ { - "description": "services supported by the vpc offering", + "description": "The internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6", "length": 255, - "name": "supportedservices", + "name": "internetprotocol", "required": false, - "type": "list" + "since": "4.17.0", + "type": "string" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "The ID of the containing domain(s), null for public offerings", "length": 255, - "name": "servicecapabilitylist", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.4", - "type": "map" + "type": "list" }, { - "description": "the name of the vpc offering", + "description": "The ID of the containing zone(s), null for public offerings", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, { - "description": "true if the VPC offering supports choosing AS number", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "specifyasnumber", + "name": "routingmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "The ID of the service offering for the VPC router appliance", "length": 255, - "name": "nsxsupportlb", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "uuid" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "enable", + "name": "networkmode", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "the ID of the service offering for the VPC router appliance", + "description": "Desired service capabilities as part of VPC offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "servicecapabilitylist", "required": false, - "type": "uuid" + "since": "4.4", + "type": "map" }, { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "description": "Services supported by the VPC offering", "length": 255, - "name": "internetprotocol", + "name": "supportedservices", "required": false, - "since": "4.17.0", - "type": "string" + "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "nsxsupportlb", "required": false, - "type": "list" + "since": "4.20.0", + "type": "boolean" }, { "description": "Name of the provider providing the service", @@ -92,219 +94,217 @@ "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" - }, - { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "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": "networkmode", + "name": "serviceproviderlist", "required": false, - "since": "4.20.0", - "type": "string" + "type": "map" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "Set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "serviceproviderlist", + "name": "enable", "required": false, - "type": "map" + "since": "4.16", + "type": "boolean" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "The display text of the VPC offering, defaults to the 'name'", "length": 255, "name": "displaytext", "required": false, "type": "string" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "description": "true if the VPC offering supports choosing AS number", "length": 255, - "name": "routingmode", + "name": "specifyasnumber", "required": false, "since": "4.20.0", + "type": "boolean" + }, + { + "description": "The name of the VPC offering", + "length": 255, + "name": "name", + "required": true, "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" - }, - { - "description": "true if network offering supports choosing AS numbers", + "description": "True if network offering supports choosing AS numbers", "name": "specifyasnumber", "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 name of the VPC offering", + "name": "name", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "Indicates if the VPC offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the vpc offering", - "name": "id", + "description": "An alternate display text of the VPC offering.", + "name": "displaytext", "type": "string" }, { - "description": "the date this vpc offering was created", + "description": "The date this VPC offering was created", "name": "created", "type": "date" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "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 can be used by NSX networks only", + "description": "True if VPC offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "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", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicated if the offering can support region level VPC", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "description": "The routing mode for the network offering, supported types are Static or Dynamic.", "name": "routingmode", "type": "string" }, + {}, { - "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "The ID of the VPC offering", + "name": "id", "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": "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": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "State of the Network provider", + "name": "state", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "The provider name", + "name": "name", + "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "UUID of the Network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" } ] }, @@ -313,6 +313,13 @@ "isasync": false, "name": "ldapCreateAccount", "params": [ + { + "description": "Details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, { "description": "Creates the user under the specified domain.", "length": 255, @@ -322,18 +329,19 @@ "type": "uuid" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Creates the account under the specified role.", "length": 255, - "name": "accounttype", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "accountdetails", + "name": "accounttype", "required": false, - "type": "map" + "type": "integer" }, { "description": "Network domain for the account's networks", @@ -342,13 +350,6 @@ "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, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Account UUID, required for adding account from external provisioning system", "length": 255, @@ -357,31 +358,30 @@ "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Unique username.", "length": 255, - "name": "timezone", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "Creates the account under the specified role.", + "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": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "account", "required": false, - "type": "uuid" + "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" }, { - "description": "User 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": "userid", + "name": "timezone", "required": false, "type": "string" } @@ -389,529 +389,529 @@ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" + "description": "The list of users associated with account", + "name": "user", + "response": [ + { + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "The type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "The API key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" + }, + { + "description": "The name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "The user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "The user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "The ID of the role", + "name": "roleid", + "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": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The user email address", + "name": "email", + "type": "string" + }, + { + "description": "The user name", + "name": "username", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "The Account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "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 domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "The Account name of the user", + "name": "account", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "The total number of Networks owned by Account", + "name": "networktotal", "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": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "type": "string" }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, { "description": "the total backup storage space (in GiB) available to the account", "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "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 state of the account", + "name": "state", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "account type (admin, domain-admin, user)", + "description": "Account type (admin, domain-admin, user)", "name": "accounttype", "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "The name of the Account", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "The total number of projects being administrated by this Account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The list of ACL groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "Name of the Domain the Account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "The total number of Instances 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 name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "The total number of Networks the Account can own", + "name": "networklimit", "type": "string" }, { - "description": "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 volume available for this account", - "name": "volumeavailable", + "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", + "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": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "The total number of public IP addresses allocated for this Account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", "type": "string" }, { - "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": "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 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" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "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": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, { "description": "the total object storage space (in GiB) available to the account", "name": "objectstorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The total number of CPU cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "The ID of the Account", + "name": "id", + "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 user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "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 api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - } - ], - "type": "list" + "description": "The default zone of the Account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "The total number of Templates which have been created by this Account", + "name": "templatetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "The total number of Instances running for this Account", + "name": "vmrunning", + "type": "integer" }, + {}, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "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 available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "The total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, - {}, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" }, - {}, { - "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 number of projects being administrated by this account", - "name": "projecttotal", + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "The total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "True if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "The total number of projects the Account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "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": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "Details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" } ], "since": "4.2.0" }, { - "description": "Copies an iso from one zone to another.", + "description": "Copies an ISO from one zone to another.", "isasync": true, "name": "copyIso", "params": [ @@ -924,7 +924,7 @@ "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 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", @@ -932,7 +932,7 @@ "type": "uuid" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "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", @@ -940,7 +940,7 @@ "type": "list" }, { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the zone the Template is being copied to.", "length": 255, "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", @@ -951,369 +951,369 @@ "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "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": "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 format of the Template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the processor bit size", + "description": "The processor bit size", "name": "bits", "type": "int" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "The tag of this Template", + "name": "templatetag", + "type": "string" + }, + { + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "description": "The Account name to which the Template belongs", + "name": "account", + "type": "string" + }, + { + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", "name": "deployasis", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "The date this Template was created", + "name": "created", + "type": "date" + }, + { + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "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": "the size of the template", + "description": "The size of the Template", "name": "size", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The name of the secondary storage host for the Template", + "name": "hostname", + "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The Template name", + "name": "name", "type": "string" }, - {}, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "The project ID of the Template", + "name": "projectid", + "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": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The project name of the Template", + "name": "project", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "The id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + {}, + { + "description": "The date this Template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "The name of the zone for this Template", + "name": "zonename", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the zone for this Template", + "name": "zoneid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The Template display text", + "name": "displaytext", "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 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": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "The Account id to which the Template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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 ID of the secondary storage host for the Template", + "name": "hostid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "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": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", + "description": "True if this Template is a public Template, false otherwise", "name": "ispublic", "type": "boolean" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "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": "Deletes a autoscale vm profile.", + "description": "Deletes a autoscale Instance profile.", "isasync": true, "name": "deleteAutoScaleVmProfile", "params": [ { - "description": "the ID of the autoscale profile", + "description": "The ID of the autoscale profile", "length": 255, "name": "id", "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", @@ -1324,24 +1324,24 @@ "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", + "description": "Any text associated with the 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" }, {} ] @@ -1352,19 +1352,19 @@ "name": "listVsphereStoragePolicyCompatiblePools", "params": [ { - "description": "ID of the storage policy", + "description": "", "length": 255, - "name": "policyid", - "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "ID of the storage policy", "length": 255, - "name": "pagesize", + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "ID of the zone", @@ -1392,19 +1392,14 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total IOPS currently in use", + "name": "usediops", "type": "long" }, { @@ -1413,39 +1408,45 @@ "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "The IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "The total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "The Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "The Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { "description": "the storage pool details", @@ -1453,90 +1454,69 @@ "type": "map" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "The ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", - "type": "long" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "True if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the pool's currently allocated disk size", + "description": "The pool's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "The name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "The storage pool path", + "name": "path", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "The name of the storage pool", + "name": "name", + "type": "string" }, { "description": "the storage access groups for the storage pool", @@ -1544,34 +1524,54 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The scope of the storage pool", + "name": "scope", "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 cluster for the storage pool", - "name": "clustername", + "description": "The state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "The Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "The date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "The storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "The storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" } ] }, @@ -1581,37 +1581,38 @@ "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", + "description": "The ID of the System VM", "length": 255, "name": "id", "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 link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "The Pod name for the System VM", + "name": "podname", "type": "string" }, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The Template ID for the System VM", + "name": "templateid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -1620,192 +1621,191 @@ "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, - {}, { - "description": "the state of the system VM", - "name": "state", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "The private IP address for the System VM", + "name": "privateip", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "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", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "The number of active console sessions for the console proxy System VM", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The name of the System VM", + "name": "name", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "Guest VLAN range", + "name": "guestvlan", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "The systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The Template name for the System VM", + "name": "templatename", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The Zone ID for the System VM", + "name": "zoneid", "type": "string" }, + {}, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "The state of the System VM", + "name": "state", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "The public netmask for the System VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "The gateway for the System VM", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "The Zone name for the System VM", + "name": "zonename", + "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "The first DNS for the System VM", + "name": "dns1", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The Pod ID for the System VM", + "name": "podid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "The date and time the System VM was created", + "name": "created", + "type": "date" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "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": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the ID of the system VM", - "name": "id", + "description": "The hostname for the System VM", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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 link local MAC address for the System VM", + "name": "linklocalmacaddress", "type": "string" }, - {} + { + "description": "The ID of the System VM", + "name": "id", + "type": "string" + }, + { + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" + } ] }, { @@ -1814,22 +1814,22 @@ "name": "listDedicatedZones", "params": [ { - "description": "the ID of the Zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "The ID of the domain associated with the zone", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list dedicated zones by affinity group", + "description": "List dedicated zones by affinity group", "length": 255, "name": "affinitygroupid", "related": "createAffinityGroup,listAffinityGroups", @@ -1837,11 +1837,11 @@ "type": "uuid" }, { - "description": "", + "description": "The name of the account associated with the zone. Must be used with domainId.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -1851,64 +1851,64 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "The ID of the Zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "dedicateZone", "response": [ { - "description": "the Name of the Zone", + "description": "The Name of the Zone", "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The Account ID to which the Zone is dedicated", + "name": "accountid", + "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", + "description": "The ID of the dedicated resource", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", + "description": "The Dedication Affinity Group ID of the zone", "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "The domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the Zone", + "description": "The ID of the Zone", "name": "zoneid", "type": "string" - }, - { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" } ] }, @@ -1918,7 +1918,7 @@ "name": "listElastistorPool", "params": [ { - "description": "the ID of the Pool", + "description": "The ID of the Pool", "length": 255, "name": "id", "required": false, @@ -1928,50 +1928,50 @@ "related": "", "response": [ { - "description": "controller of the pool", - "name": "controllerid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "The ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the current available space of the pool", + "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", + "description": "The name of the storage pool", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "the state of the storage pool", + "description": "The state of the storage pool", "name": "state", "type": "string" }, + {}, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Available IOPS of the pool", + "name": "maxiops", + "type": "long" + }, + { + "description": "Default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "Controller of the pool", + "name": "controllerid", "type": "string" } ] @@ -1981,14 +1981,6 @@ "isasync": true, "name": "changeBgpPeersForNetwork", "params": [ - { - "description": "UUID of the network which the Bgp Peers are associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, { "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", "length": 255, @@ -1996,38 +1988,48 @@ "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForNetwork,changeBgpPeersForVpc", "required": false, "type": "list" + }, + { + "description": "UUID of the network which the Bgp Peers are associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "response": [ { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of zone to which the bgp peer 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, + {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { @@ -2036,35 +2038,33 @@ "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" - }, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { "description": "AS number of bgp peer", "name": "asnumber", "type": "long" }, - {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { @@ -2078,121 +2078,121 @@ "type": "map" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" } ], "since": "4.20.0" }, { - "description": "list Tungsten-Fabric LB health monitor", + "description": "List Tungsten-Fabric LB health monitor", "isasync": false, "name": "listTungstenFabricLBHealthMonitor", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of lb rule", + "description": "List by keyword", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "The ID of lb rule", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "The LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the health monitor ID", + "description": "The health monitor ID", "name": "id", "type": "long" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the health monitor type", - "name": "type", + "description": "The health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the health monitor timeout", + "description": "The health monitor timeout", "name": "timeout", "type": "int" }, + {}, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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 health monitor URL path", + "name": "urlpath", "type": "string" }, { - "description": "the health monitor expected code", + "description": "Tungsten-Fabric provider zone ID", + "name": "zoneid", + "type": "long" + }, + { + "description": "The health monitor expected code", "name": "expectedcode", "type": "string" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "The health monitor type", + "name": "type", "type": "string" }, { - "description": "the health monitor retry", + "description": "The health monitor retry", "name": "retry", "type": "int" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the health monitor http method", + "description": "The health monitor HTTP method", "name": "httpmethod", "type": "string" }, - {}, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" - }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -2201,14 +2201,6 @@ "isasync": true, "name": "removeNodesFromKubernetesCluster", "params": [ - { - "description": "comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)", - "length": 255, - "name": "nodeids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "list" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -2216,75 +2208,83 @@ "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster", "required": true, "type": "uuid" + }, + { + "description": "comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)", + "length": 255, + "name": "nodeids", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "list" } ], "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", "response": [ { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, - {}, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "The ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "The name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "The description of the Kubernetes cluster", + "name": "description", + "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", + "description": "Path of the domain to which the Kubernetes cluster belongs", "name": "domainpath", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "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": "URL end point for the Kubernetes cluster", @@ -2292,43 +2292,43 @@ "type": "string" }, { - "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": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "The memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { @@ -2337,151 +2337,151 @@ "type": "string" }, { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" - }, - { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "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 name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "The name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "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": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "The cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, + {}, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "The list of virtualmachines associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "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 name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "The Account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "The ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "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 size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, - {}, { - "description": "keypair details", - "name": "keypair", + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "The state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" } ], "since": "4.21.0" }, { - "description": "Deletes account from the project", + "description": "Deletes Account from the project", "isasync": true, "name": "deleteAccountFromProject", "params": [ { - "description": "ID of the project to remove the account from", + "description": "ID of the project to remove the Account from", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -2489,7 +2489,7 @@ "type": "uuid" }, { - "description": "name of the account to be removed from the project", + "description": "Name of the Account to be removed from the project", "length": 255, "name": "account", "required": true, @@ -2498,27 +2498,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", + "description": "The current status of the latest async job acting 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" - } + }, + {} ], "since": "3.0.0" }, @@ -2528,11 +2528,11 @@ "name": "updateGuestOs", "params": [ { - "description": "whether this guest OS is available for end users", + "description": "Map of (key/value pairs)", "length": 255, - "name": "forDisplay", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "the ID of the OS category", @@ -2543,6 +2543,13 @@ "since": "4.21.0", "type": "uuid" }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" + }, { "description": "UUID of the Guest OS", "length": 255, @@ -2551,13 +2558,6 @@ "required": true, "type": "uuid" }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "Unique display name for Guest OS", "length": 255, @@ -2569,51 +2569,51 @@ "related": "listOsTypes,addGuestOs", "response": [ { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" - }, - { - "description": "is the guest OS user defined", + "description": "Is the guest OS user defined", "name": "isuserdefined", "type": "boolean" }, {}, + {}, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "The ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the OS type", - "name": "id", + "description": "The name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the ID of the OS category", + "description": "The name of the OS type", + "name": "name", + "type": "string" + }, + { + "description": "The ID of the OS category", "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the name of the OS type", - "name": "name", + "description": "The name of the OS category", + "name": "oscategoryname", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.4.0" @@ -2624,36 +2624,43 @@ "name": "listGuestVlans", "params": [ { - "description": "List by keyword", + "description": "List guest VLAN by vnet", "length": 255, - "name": "keyword", + "name": "vnet", "required": false, "type": "string" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "List guest VLAN by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "Limits search results to allocated guest VLAN. False by default.", "length": 255, "name": "allocatedonly", "required": false, "type": "boolean" }, { - "description": "list guest vlan by vnet", + "description": "", "length": 255, - "name": "vnet", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list guest vlan by physical network", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list guest vlan by zone", + "description": "List guest VLAN by zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -2661,74 +2668,65 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list guest vlan by id", + "description": "List guest VLAN by ID", "length": 255, "name": "id", "required": false, "type": "long" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "The zone ID of the guest VLAN range", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "The project ID of the guest VLAN range", + "name": "projectid", "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 physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "The zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "date the guest VLAN was taken", + "description": "Date the guest VLAN was taken", "name": "taken", "type": "date" }, { - "description": "the guest VLAN", - "name": "vlan", - "type": "string" + "description": "The list of Networks who use this guest VLAN", + "name": "network", + "type": "list" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "The allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { @@ -2737,45 +2735,47 @@ "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "The project name of the guest VLAN range", + "name": "project", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The physical Network name of the guest VLAN range", + "name": "physicalnetworkname", + "type": "string" }, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "The domain name of the guest VLAN range", + "name": "domain", "type": "string" }, + {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "The guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", - "type": "string" + "description": "The guest VLAN ID", + "name": "id", + "type": "long" }, { - "description": "the domain ID of the guest VLAN range", + "description": "The domain ID of the guest VLAN range", "name": "domainid", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "The physical Network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", - "type": "string" - } + "description": "True if the guest VLAN is dedicated to the Account", + "name": "isdedicated", + "type": "boolean" + }, + {} ], "since": "4.17.0" }, @@ -2785,7 +2785,7 @@ "name": "updateResourceLimit", "params": [ { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "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. 5 - Project. Number of Projects 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": true, @@ -2800,19 +2800,18 @@ "type": "uuid" }, { - "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": "Update resource for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": " Maximum resource limit.", "length": 255, - "name": "account", + "name": "max", "required": false, - "type": "string" + "type": "long" }, { "description": "Tag for the resource type", @@ -2823,75 +2822,76 @@ "type": "string" }, { - "description": " Maximum resource limit.", + "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": "max", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "long" + "type": "uuid" } ], "related": "listResourceLimits", "response": [ { - "description": "the account of the resource limit", - "name": "account", + "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 name of the resource limit", - "name": "project", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The Account of the resource limit", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the resource limit belongs", + "description": "Path of the domain to which the resource limit belongs", "name": "domainpath", "type": "string" }, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "The project name of the resource limit", + "name": "project", "type": "string" }, - {}, { - "description": "the domain name of the resource limit", + "description": "The domain name of the resource limit", "name": "domain", "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 ID of the resource limit", + "name": "projectid", "type": "string" }, + {}, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "description": "The maximum number of the resource. A -1 means the resource currently has no limit.", "name": "max", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project id of the resource limit", - "name": "projectid", + "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" } ] @@ -2913,20 +2913,13 @@ "related": "listGuiThemes,updateGuiTheme,createGuiTheme", "response": [ { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "domainids", - "type": "string" - }, - {}, - {}, - { - "description": "ID of the custom GUI theme.", - "name": "id", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "accountids", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { @@ -2934,55 +2927,62 @@ "name": "description", "type": "string" }, + {}, { "description": "Whether to consider the subdomains of the informed domain IDs.", "name": "recursivedomains", "type": "boolean" }, { - "description": "Name of the GUI theme.", - "name": "name", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", + "type": "boolean" }, { "description": "When the GUI theme was removed.", "name": "removed", "type": "date" }, + {}, { - "description": "When the GUI theme was created.", - "name": "created", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "jsonconfiguration", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "name": "commonnames", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", - "name": "ispublic", - "type": "boolean" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" } ], "since": "4.21.0.0" @@ -2993,7 +2993,7 @@ "name": "deleteStaticRoute", "params": [ { - "description": "the ID of the static route", + "description": "The ID of the static route", "length": 255, "name": "id", "related": "createStaticRoute,listStaticRoutes", @@ -3003,36 +3003,36 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } ] }, { - "description": "get load balancer certificate", + "description": "Get load balancer certificate", "isasync": false, "name": "getLoadBalancerSslCertificate", "params": [ { - "description": "the ID of Lb", + "description": "The ID of Lb", "length": 255, "name": "id", "related": "getLoadBalancerSslCertificate", @@ -3043,41 +3043,41 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Key", + "name": "key", + "type": "string" + }, + { + "description": "chain", + "name": "chain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "crt", "name": "crt", "type": "string" }, - {}, { - "description": "key", - "name": "key", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "chain", - "name": "chain", - "type": "string" - } + {}, + {} ] }, { - "description": "Destroys a l2tp/ipsec remote access vpn", + "description": "Destroys a l2tp/ipsec remote access VPN", "isasync": true, "name": "deleteRemoteAccessVpn", "params": [ { - "description": "public ip address id of the vpn server", + "description": "Public IP address id of the VPN server", "length": 255, "name": "publicipid", "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -3087,24 +3087,24 @@ ], "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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -3116,92 +3116,92 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the zones to start maintenance on", + "description": "The IDs of the hosts to start maintenance on", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "hostids", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "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": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "Optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "timeout", "required": false, - "type": "list" + "type": "integer" }, { - "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": "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "The IDs of the pods to start maintenance on", "length": 255, - "name": "payload", + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "list" }, { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "The IDs of the clusters to start maintenance on", "length": 255, - "name": "timeout", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" } ], "related": "", "response": [ { - "description": "indicates if the rolling maintenance operation was successful", + "description": "Indicates if the rolling maintenance operation was successful", "name": "success", "type": "boolean" }, { - "description": "the hosts updated", + "description": "The hosts updated", "name": "hostsupdated", "response": [ { - "description": "end date of the update on the host", - "name": "enddate", + "description": "Start date of the update on the host", + "name": "startdate", "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "The name of the updated host", + "name": "hostname", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "End date of the update on the host", + "name": "enddate", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "Output of the maintenance script on the host", + "name": "output", "type": "string" }, { - "description": "the ID of the updated host", + "description": "The ID of the updated host", "name": "hostid", "type": "string" } @@ -3209,77 +3209,69 @@ "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": "in case of failure, details are displayed", + "description": "In case of failure, details are displayed", "name": "details", "type": "string" }, { - "description": "the hosts skipped", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The hosts skipped", "name": "hostsskipped", "response": [ { - "description": "the reason to skip the host", + "description": "The reason to skip the host", "name": "reason", "type": "string" }, { - "description": "the ID of the skipped host", + "description": "The ID of the skipped host", "name": "hostid", "type": "string" }, { - "description": "the name of the skipped host", + "description": "The name of the skipped host", "name": "hostname", "type": "string" } ], "type": "list" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {} ] }, { - "description": "list Tungsten-Fabric application policy set", + "description": "List Tungsten-Fabric application policy set", "isasync": false, "name": "listTungstenFabricApplicationPolicySet", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "The uuid of Tungsten-Fabric application policy set", "length": 255, "name": "applicationpolicysetuuid", "required": false, "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": 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" }, @@ -3289,14 +3281,28 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "The ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "List Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { "description": "Tungsten-Fabric application policy uuid", @@ -3308,57 +3314,59 @@ "name": "name", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "List Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Updates network ACL list", + "description": "Updates Network ACL list", "isasync": true, "name": "updateNetworkACLList", "params": [ { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "Name of the network ACL list", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "Name of the network ACL list", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the ID of the network ACL", + "description": "An optional field, whether to the display the list to the end User or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "The ID of the network ACL", "length": 255, "name": "id", "related": "createNetworkACLList,listNetworkACLLists", @@ -3371,55 +3379,39 @@ "name": "description", "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" } ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ], "since": "4.4" }, { - "description": "Restore a VM to original template/ISO or new template/ISO", + "description": "Restore an Instance to original Template/ISO or new Template/ISO", "isasync": true, "name": "restoreVirtualMachine", "params": [ - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, @@ -3445,6 +3437,14 @@ "since": "4.19.1", "type": "uuid" }, + { + "description": "Instance ID", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "Optional field to expunge old root volume after restore.", "length": 255, @@ -3454,7 +3454,7 @@ "type": "boolean" }, { - "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": "An optional Template Id to restore Instance from the new Template. This can be an ISO id in case of restore Instance deployed using ISO", "length": 255, "name": "templateid", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -3462,1162 +3462,1167 @@ "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + {}, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + {}, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + {}, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "The project name of the Instance", + "name": "project", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "Tag value", + "name": "value", "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": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", + "description": "The read (IO) of disk on the Instance", "name": "diskioread", "type": "long" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, - {}, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The outgoing Network traffic on the host in KiB", + "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 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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The ID of the NIC", + "name": "id", "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the nic", + "description": "The type of the NIC", "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "The 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": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "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 traffic type of the nic", - "name": "traffictype", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The gateway of the NIC", + "name": "gateway", "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", + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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 gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The description of the affinity group", + "name": "description", "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 name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "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 ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", + "description": "The list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the list of resource tags associated with the rule", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", + "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag key name", + "name": "key", "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" - }, - { - "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", - "type": "integer" - }, - { - "description": "the id of the security group rule", + "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", + "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" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", + "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", + "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", + "description": "The CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "Account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the ending IP of the security group rule ", + "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "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": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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" - } - ], - "type": "set" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "The domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 project name of the group", + "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 Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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 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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "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", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" } ], @@ -4638,27 +4643,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", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -4668,7 +4673,7 @@ "name": "notifyBaremetalProvisionDone", "params": [ { - "description": "mac of the nic used for provision", + "description": "MAC of the NIC used for provision", "length": 255, "name": "mac", "required": true, @@ -4677,26 +4682,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on 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", + "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" } ] }, @@ -4713,7 +4718,7 @@ "type": "string" }, { - "description": "ucs manager id", + "description": "Ucs manager ID", "length": 255, "name": "ucsmanagerid", "related": "listUcsManagers,addUcsManager", @@ -4738,41 +4743,41 @@ "related": "associateUcsProfileToBlade", "response": [ { - "description": "ucs blade id", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "UCS blade dn", + "name": "bladedn", "type": "string" }, + {}, + {}, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "CloudStack host ID this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "UCS manager ID", + "name": "ucsmanagerid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "Associated UCS profile dn", + "name": "profiledn", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "UCS blade ID", + "name": "id", + "type": "string" } ] }, @@ -4791,23 +4796,23 @@ ], "related": "getVolumeiScsiName", "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -4815,6 +4820,13 @@ "isasync": false, "name": "updateOsCategory", "params": [ + { + "description": "Name for the OS category", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "ID of the OS category", "length": 255, @@ -4836,46 +4848,34 @@ "name": "isfeatured", "required": false, "type": "boolean" - }, - { - "description": "Name for the OS category", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "listOsCategories,addOsCategory", "response": [ { - "description": "the name of the OS category", + "description": "The name of the OS category", "name": "name", "type": "string" }, - {}, - {}, - { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, { - "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 OS category", + "description": "The ID of the OS category", "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -4883,6 +4883,11 @@ "description": "Whether the OS category is featured", "name": "isfeatured", "type": "boolean" + }, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" } ], "since": "4.21.0" @@ -4892,14 +4897,6 @@ "isasync": false, "name": "updateHost", "params": [ - { - "description": "the id of Os category to update the host with", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories,addOsCategory", - "required": false, - "type": "uuid" - }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, @@ -4909,57 +4906,57 @@ "type": "map" }, { - "description": "Change the name of host", + "description": "List of tags to be added to the host", "length": 255, - "name": "name", + "name": "hosttags", "required": false, - "since": "4.15", - "type": "string" + "type": "list" }, { - "description": "Add an annotation to this host", + "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this host, externaldetails field ignored; if false or not set, no action)", "length": 255, - "name": "annotation", + "name": "cleanupexternaldetails", "required": false, - "since": "4.11", - "type": "string" + "since": "4.22.0", + "type": "boolean" }, { - "description": "the new uri for the secondary storage: nfs://host/path", + "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": "url", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this host, externaldetails field ignored; if false or not set, no action)", + "description": "Change the name of host", "length": 255, - "name": "cleanupexternaldetails", + "name": "name", "required": false, - "since": "4.22.0", - "type": "boolean" + "since": "4.15", + "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "The new URI for the secondary storage: nfs://host/path", "length": 255, - "name": "hosttags", + "name": "url", "required": false, - "type": "list" + "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": "The ID of OS category to update the host with", "length": 255, - "name": "allocationstate", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the host to update", + "description": "Add an annotation to this host", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": true, - "type": "uuid" + "name": "annotation", + "required": false, + "since": "4.11", + "type": "string" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -4967,451 +4964,459 @@ "name": "istagarule", "required": false, "type": "boolean" + }, + { + "description": "The ID of the host to update", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "required": true, + "type": "uuid" } ], "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "The 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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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 Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "The CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "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 state of the host", + "name": "state", + "type": "status" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "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 type of the cluster that host belongs to", - "name": "clustertype", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "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", + "description": "The total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The 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": "The ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently allocated in percentage", + "description": "The amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "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 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": "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": "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 Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "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 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 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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "The host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "The OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "The Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "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 admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "The list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more Instances that can be deployed 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 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": "Maximum no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "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": "True if the host is Ha host (dedicated to Instances 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 management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "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 IP address of the host", - "name": "ipaddress", + "description": "The last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "The Pod ID of the host", + "name": "podid", + "type": "string" }, + {}, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "The Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "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 storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" } ] }, @@ -5421,74 +5426,74 @@ "name": "createEgressFirewallRule", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The CIDR list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "fordisplay", + "name": "destcidrlist", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "The ending port of firewall rule", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "Type of the ICMP message being sent", "length": 255, - "name": "destcidrlist", + "name": "icmptype", "required": false, - "type": "list" + "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" }, { - "description": "type of the icmp message being sent", + "description": "Type of firewallrule: system/user", "length": 255, - "name": "icmptype", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "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,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" + "type": "uuid" }, { - "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 starting port of firewall rule", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "startport", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the network id of the port forwarding rule", + "description": "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "error code for this icmp message", + "description": "The starting port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" } @@ -5496,148 +5501,148 @@ "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "The Network ID of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "error code for this icmp message", + "description": "The ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "Error code for this ICMP message", "name": "icmpcode", "type": "integer" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "The ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "The state of the rule", + "name": "state", + "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 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 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address id for the firewall rule", + "description": "The public IP address ID for the firewall rule", "name": "ipaddressid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The public IP address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of the ICMP message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } ], "type": "list" - }, - {}, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "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" } ] }, @@ -5647,500 +5652,467 @@ "name": "listSecurityGroups", "params": [ { - "description": "list the security group by the id provided", + "description": "Lists security groups by name", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists security groups by virtual machine id", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List the security group by the id provided", "length": 255, - "name": "page", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists security groups by name", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "securitygroupname", + "name": "account", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists security groups by Instance id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by 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 only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "tags", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "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 project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "Tag key name", + "name": "key", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 domain associated with the tag", - "name": "domain", - "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": "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the ID of the security group", - "name": "id", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "The number of Instances associated with this Security Group", + "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 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 egress rules associated with the security group", + "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 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", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", + "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 account associated with the tag", + "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": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The 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": "resource type", - "name": "resourcetype", + "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" } ], "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": "account owning the security group rule", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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 account owning the security group", - "name": "account", - "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 name of the security group", - "name": "name", + "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": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "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": "the domain associated with the tag", - "name": "domain", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "The 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" } ], "type": "set" - } - ] - }, - { - "description": "Enables a role", - "isasync": false, - "name": "enableRole", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "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", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The project name of the group", + "name": "project", + "type": "string" } - ], - "since": "4.20.0" + ] }, { "description": "List OAuth providers registered", "isasync": false, "name": "listOauthProvider", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the OAuth provider", "length": 255, @@ -6150,9 +6122,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "Name of the provider", "length": 255, - "name": "keyword", + "name": "provider", "required": false, "type": "string" }, @@ -6163,13 +6135,6 @@ "required": false, "type": "integer" }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -6180,13 +6145,6 @@ ], "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ - {}, - { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - }, - {}, { "description": "ID of the provider", "name": "id", @@ -6197,11 +6155,6 @@ "name": "provider", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Redirect URI registered in the OAuth provider", "name": "redirecturi", @@ -6212,6 +6165,11 @@ "name": "enabled", "type": "boolean" }, + { + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" + }, { "description": "Description of the provider registered", "name": "description", @@ -6222,11 +6180,18 @@ "name": "clientid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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": "name", @@ -6236,38 +6201,78 @@ "since": "4.19.0" }, { - "description": "Delete Service Package", + "description": "Enables a role", "isasync": false, - "name": "deleteServicePackageOffering", + "name": "enableRole", "params": [ { - "description": "the service offering ID", + "description": "ID of the role", "length": 255, "name": "id", - "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "related": "createRole,importRole,listRoles,updateRole", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "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.20.0" + }, + { + "description": "Delete Service Package", + "isasync": false, + "name": "deleteServicePackageOffering", + "params": [ + { + "description": "The service offering ID", + "length": 255, + "name": "id", + "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "True 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" }, @@ -6279,6 +6284,14 @@ "isasync": false, "name": "updateSharedFileSystem", "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + }, { "description": "the name of the shared filesystem.", "length": 255, @@ -6292,169 +6305,105 @@ "name": "description", "required": false, "type": "string" - }, - { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, - "type": "uuid" } ], "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, { "description": "path to mount the shared filesystem", "name": "path", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - {}, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", + "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": "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": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { @@ -6463,8 +6412,33 @@ "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { @@ -6473,8 +6447,29 @@ "type": "long" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -6482,196 +6477,257 @@ "name": "diskofferingname", "type": "string" }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 Instance 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", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", + "description": "ID of the VPC to which the NIC belongs", "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ip address of the nic", + "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 the NIC", + "name": "gateway", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "list" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { @@ -6679,66 +6735,15 @@ "name": "diskioread", "type": "long" }, - {}, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "size of the shared filesystem", "name": "size", "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" } ], "since": "4.20.0" @@ -6766,78 +6771,78 @@ ], "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of zone to which the IPv4 subnet belongs to.", "name": "zonename", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, + {}, { "description": "the domain ID of the IPv4 subnet", "name": "domainid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "date when this IPv4 subnet 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 name of the IPv4 subnet", - "name": "domain", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" }, { - "description": "Destroys a system virtual machine.", + "description": "Destroys a System VM.", "isasync": true, "name": "destroySystemVm", "params": [ { - "description": "The ID of the system virtual machine", + "description": "The ID of the System VM", "length": 255, "name": "id", "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", @@ -6848,211 +6853,211 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "The ID of the System VM", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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 systemvm agent version", + "name": "version", "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 state of the system VM", - "name": "state", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "The Pod name for the System VM", + "name": "podname", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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": "Guest VLAN range", + "name": "guestvlan", + "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "The Zone name for the System VM", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", + "description": "The hypervisor on which the Template runs", "name": "hypervisor", "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": "guest vlan range", - "name": "guestvlan", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "The Template ID for the System VM", + "name": "templateid", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "The state of the System VM", + "name": "state", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "The number of active console sessions for the console proxy System VM", + "name": "activeviewersessions", + "type": "integer" + }, + { + "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 system VM type", - "name": "systemvmtype", + "description": "The name of the System VM", + "name": "name", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "The Pod ID for the System VM", + "name": "podid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The link local MAC address for the System VM", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance 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 Pod ID for the system VM", - "name": "podid", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "The public MAC address for the System VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "The hostname for the System VM", + "name": "hostname", "type": "string" }, { - "description": "the first DNS for the system VM", + "description": "The first DNS for the System VM", "name": "dns1", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - {}, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The second DNS for the System VM", + "name": "dns2", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The gateway for the System VM", + "name": "gateway", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "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 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 netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" } ] }, @@ -7062,21 +7067,14 @@ "name": "archiveEvents", "params": [ { - "description": "archive by event type", + "description": "Archive by event type", "length": 255, "name": "type", "required": false, "type": "string" }, { - "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "the IDs of the events", + "description": "The IDs of the events", "length": 255, "name": "ids", "related": "listEvents", @@ -7084,36 +7082,43 @@ "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\")", + "description": "Start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, "name": "startdate", "required": false, "type": "date" + }, + { + "description": "End date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "response": [ { - "description": "the 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", + "description": "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -7124,139 +7129,139 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the network id", + "description": "AS number", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "asnumber", + "related": "listASNumbers", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "account name", + "description": "the zone ID", "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "pagesize", + "name": "isallocated", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the zone ID", + "description": "the AS Number range ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the vpc id", + "description": "the network id", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "to indicate if the AS number is allocated to any network", + "description": "account name", "length": 255, - "name": "isallocated", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "AS number", + "description": "domain id", "length": 255, - "name": "asnumber", - "related": "listASNumbers", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the AS Number range ID", + "description": "the vpc id", "length": 255, - "name": "asnrangeid", - "related": "createASNRange,listASNRanges", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "domain id", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "Zone ID", - "name": "zoneid", + "description": "Account ID", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC ID", + "name": "vpcid", + "type": "string" }, { - "description": "AS Number ID", - "name": "asnrangeid", + "description": "Allocated Date", + "name": "allocated", + "type": "date" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VPC ID", - "name": "vpcid", + "description": "ID of the AS Number", + "name": "id", "type": "string" }, + { + "description": "Created Date", + "name": "created", + "type": "date" + }, {}, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, { "description": "the domain name", "name": "domain", "type": "string" }, - { - "description": "Account ID", - "name": "accountid", - "type": "string" - }, { "description": "AS Number", "name": "asnumber", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Allocated Date", - "name": "allocated", - "type": "date" - }, - { - "description": "Network Name", - "name": "associatednetworkname", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { @@ -7265,45 +7270,45 @@ "type": "string" }, { - "description": "Allocation state", - "name": "allocationstate", + "description": "the zone name of the AS Number range", + "name": "zonename", "type": "string" }, { - "description": "ID of the AS Number", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "Network Name", + "name": "associatednetworkname", "type": "string" }, { - "description": "Network ID", - "name": "associatednetworkid", + "description": "AS Number ID", + "name": "asnrangeid", "type": "string" }, - {}, - { - "description": "Created Date", - "name": "created", - "type": "date" - }, { - "description": "the account name", - "name": "account", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the zone name of the AS Number range", - "name": "zonename", + "description": "Allocation state", + "name": "allocationstate", "type": "string" }, { "description": "VPC Name", "name": "vpcname", "type": "string" + }, + {}, + { + "description": "the account name", + "name": "account", + "type": "string" } ], "since": "4.20.0" @@ -7314,7 +7319,7 @@ "name": "deleteSecondaryStagingStore", "params": [ { - "description": "the staging store ID", + "description": "The staging store ID", "length": 255, "name": "id", "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", @@ -7324,27 +7329,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -7354,27 +7359,25 @@ "name": "listUserData", "params": [ { - "description": "the ID of the Userdata", + "description": "", "length": 255, - "name": "id", - "related": "listUserData,listCniConfiguration", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Userdata name to look for", @@ -7384,45 +7387,47 @@ "type": "string" }, { - "description": "", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "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 Instances", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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 only resources belonging to the domain specified", + "description": "The ID of the Userdata", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "id", + "related": "listUserData,listCniConfiguration", "required": false, "type": "uuid" } @@ -7430,75 +7435,75 @@ "related": "listCniConfiguration", "response": [ { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", - "name": "params", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the User Data", - "name": "name", + "description": "The project name of the User Data", + "name": "project", "type": "string" }, { - "description": "base64 encoded User Data content", + "description": "Base64 encoded User Data content", "name": "userdata", "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 User Data owner", - "name": "domainid", + "description": "The project id of the User Data", + "name": "projectid", "type": "string" }, { - "description": "the owner of the User Data", - "name": "account", + "description": "The domain name of the User Data owner", + "name": "domain", "type": "string" }, { - "description": "the project name of the User Data", - "name": "project", + "description": "Path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the User Data owner", - "name": "domain", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "path of the domain to which the User Data owner belongs", - "name": "domainpath", + "description": "The owner of the User Data", + "name": "account", "type": "string" }, { - "description": "ID of the User Data", - "name": "id", + "description": "The domain id of the User Data owner", + "name": "domainid", "type": "string" }, { - "description": "the owner id of the User Data", + "description": "The owner id of the User Data", "name": "accountid", "type": "string" }, { - "description": "the project id of the User Data", - "name": "projectid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", + "name": "params", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the User Data", + "name": "name", + "type": "string" + }, + { + "description": "ID of the User Data", + "name": "id", "type": "string" } ], @@ -7510,225 +7515,225 @@ "name": "updateLoadBalancer", "params": [ { - "description": "the ID of the load balancer", + "description": "An optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "The ID of the load balancer", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, "name": "customid", "required": false, "since": "4.4", "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the Load Balancer", - "name": "name", + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "The domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", + "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 name of the instance", - "name": "name", + "description": "The Instance ID", + "name": "id", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "The IP address of the Instance", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "The name of the Instance", + "name": "name", "type": "string" - } - ], - "type": "list" - }, - {}, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" }, { - "description": "the state of the load balancer rule", + "description": "The state of the Instance", "name": "state", "type": "string" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" } ], "type": "list" }, - {}, { - "description": "the Load Balancer ID", - "name": "id", + "description": "Load Balancer Network id", + "name": "networkid", "type": "string" }, { - "description": "the account of the Load Balancer", + "description": "The Account of the Load Balancer", "name": "account", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", + "description": "The list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", + "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": "is rule for display to the regular user", + "description": "Load Balancer source IP", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "Load Balancer source IP Network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "Is rule for display to the regular User", "name": "fordisplay", "type": "boolean" }, { - "description": "the description of the Load Balancer", + "description": "The Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "The name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "The description of the Load Balancer", "name": "description", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "The project name of the Load Balancer", + "name": "project", "type": "string" - } + }, + { + "description": "The domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -7737,14 +7742,6 @@ "isasync": true, "name": "scaleSystemVm", "params": [ - { - "description": "the service offering ID to apply to the system vm", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "The ID of the system vm", "length": 255, @@ -7754,170 +7751,178 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, "name": "details", "required": false, "type": "map" + }, + { + "description": "The service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "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 System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "The last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "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 second DNS for the system VM", - "name": "dns2", + "description": "The public IP address for the System VM", + "name": "publicip", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "The second DNS for the System VM", + "name": "dns2", "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 public MAC address for the system VM", - "name": "publicmacaddress", + "description": "Guest VLAN range", + "name": "guestvlan", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "The Template name for the System VM", + "name": "templatename", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The state of the System VM", + "name": "state", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" }, + {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, + {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The Zone name for the System VM", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the System VM", + "name": "name", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "The systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the ID of the system VM", + "description": "The ID of the System VM", "name": "id", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "The hostname for the System VM", + "name": "hostname", "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 template name for the system VM", - "name": "templatename", + "description": "The Template ID for the System VM", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "The first DNS for the System VM", + "name": "dns1", "type": "string" }, { @@ -7926,49 +7931,49 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the 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 hostname for the system VM", - "name": "hostname", + "description": "The Zone ID for the System VM", + "name": "zoneid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "The public MAC address for the System VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The public netmask for the System VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "The gateway for the System VM", + "name": "gateway", + "type": "string" } ] }, @@ -7985,18 +7990,18 @@ "type": "string" }, { - "description": "List by keyword", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "keyword", + "name": "secretcode", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -8006,31 +8011,15 @@ "type": "integer" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "", "length": 255, - "name": "secretcode", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateOauthProvider", "response": [ - { - "description": "Name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "ID of the provider", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - }, { "description": "Client ID registered in the OAuth provider", "name": "clientid", @@ -8042,15 +8031,21 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the 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": "Description of the provider registered", @@ -8058,14 +8053,24 @@ "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { "description": "Name of the provider", "name": "name", "type": "string" + }, + { + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" + }, + { + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" } ], "since": "4.19.0" @@ -8076,18 +8081,19 @@ "name": "listClusterDrsPlan", "params": [ { - "description": "List by keyword", + "description": "ID of the drs plan", "length": 255, - "name": "keyword", + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -8097,12 +8103,11 @@ "type": "integer" }, { - "description": "ID of the drs plan", + "description": "", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "ID of the cluster", @@ -8115,26 +8120,23 @@ ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ + {}, {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { "description": "Id of the cluster", @@ -8147,17 +8149,20 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" }, - {}, - {} + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + } ], "since": "4.19.0" }, @@ -8167,115 +8172,116 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "lists clusters by Pod ID", + "description": "Whether this cluster is managed by cloudstack", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "managedstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "CPU arch of the clusters", "length": 255, - "name": "pagesize", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20.1", + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "the name of the storage access group", "length": 255, - "name": "name", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "CPU arch of the clusters", + "description": "", "length": 255, - "name": "arch", + "name": "page", "required": false, - "since": "4.20.1", - "type": "string" + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "Lists clusters by cluster type", "length": 255, - "name": "managedstate", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "Lists clusters by allocation state", "length": 255, - "name": "clustertype", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "List by keyword", "length": 255, - "name": "showcapacities", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "Lists clusters by the cluster name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "Lists clusters by Pod ID", "length": 255, - "name": "allocationstate", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "Lists clusters by hypervisor type", "length": 255, "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the name of the storage access group", + "description": "Flag to display the capacity of the clusters", "length": 255, - "name": "storageaccessgroup", + "name": "showcapacities", "required": false, - "since": "4.21.0", - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by Zone ID", + "description": "Lists clusters by Zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "Lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" } ], "related": "addCluster,updateCluster", "response": [ + {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "comma-separated list of storage access groups on the pod", @@ -8283,168 +8289,167 @@ "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "The hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The cluster name", + "name": "name", "type": "string" }, - {}, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "The Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", + "description": "The CPU overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "The Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "Whether this cluster is managed by Cloudstack", "name": "managedstate", "type": "string" }, + {}, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the capacity of the Cluster", + "description": "The capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "The Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity name", + "description": "The capacity name", "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "The Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the Pod ID", + "description": "The Pod ID", "name": "podid", "type": "string" }, { - "description": "the capacity type", + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "The capacity type", "name": "type", "type": "short" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "The capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" } ], "type": "list" }, - {}, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "The type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the cluster ID", - "name": "id", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -8453,13 +8458,13 @@ "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The cluster ID", + "name": "id", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" } ] @@ -8470,43 +8475,44 @@ "name": "listProjectInvitations", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list invitations by state", + "description": "List invitations by ID", "length": 255, - "name": "state", + "name": "id", + "related": "listProjectInvitations", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List by project ID", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "If true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "listall", + "name": "activeonly", "required": false, "type": "boolean" }, { - "description": "list invitation by user ID", + "description": "List invitation by user ID", "length": 255, "name": "userid", "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", @@ -8514,26 +8520,26 @@ "type": "uuid" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "activeonly", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list by project id", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -8543,83 +8549,82 @@ "type": "integer" }, { - "description": "list invitations by id", + "description": "List invitations by state", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "state", "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": "", "response": [ + {}, { - "description": "the id of the project", - "name": "projectid", + "description": "Path of the Domain the project belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "The ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "The User ID", + "name": "userid", "type": "string" }, - {}, { - "description": "the id of the invitation", - "name": "id", + "description": "The name of the project", + "name": "project", "type": "string" }, { - "description": "the invitation state", - "name": "state", + "description": "The email the invitation was sent to", + "name": "email", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", + "description": "The Account name of the project's owner", + "name": "account", "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "The domain ID the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "The domain name where the project belongs to", + "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "The ID of the invitation", + "name": "id", "type": "string" }, { - "description": "the email the invitation was sent to", - "name": "email", + "description": "The invitation state", + "name": "state", "type": "string" } ], @@ -8631,30 +8636,44 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "Lists rule with the specified ID.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "The ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "the network ID for the egress firewall services", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, @@ -8668,212 +8687,198 @@ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "The network ID for the egress firewall services", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of IP address of the firewall services", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "The public IP address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "error code for this icmp message", + "description": "Error code for this ICMP message", "name": "icmpcode", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The 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", + "description": "The Network ID of the firewall rule", + "name": "networkid", "type": "string" }, + {}, + { + "description": "The state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "Type of the ICMP message being sent", + "name": "icmptype", + "type": "integer" + }, { - "description": "the protocol of the firewall rule", + "description": "The protocol of the firewall rule", "name": "protocol", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "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 public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "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": "the ending port of firewall rule's port range", - "name": "endport", + "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" - }, - {} + } ] }, { @@ -8882,583 +8887,503 @@ "name": "listClustersMetrics", "params": [ { - "description": "List by keyword", + "description": "Lists clusters by Pod ID", "length": 255, - "name": "keyword", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "CPU arch of the clusters", + "description": "Lists clusters by the cluster name", "length": 255, - "name": "arch", + "name": "name", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "Flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "List by keyword", "length": 255, - "name": "managedstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name of the storage access group", + "description": "Lists clusters by cluster type", "length": 255, - "name": "storageaccessgroup", + "name": "clustertype", "required": false, - "since": "4.21.0", "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": "string" + "type": "uuid" }, { - "description": "", + "description": "the name of the storage access group", "length": 255, - "name": "pagesize", + "name": "storageaccessgroup", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "Lists clusters by Zone ID", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the capacity of the clusters", + "description": "Lists clusters by allocation state", "length": 255, - "name": "showcapacities", + "name": "allocationstate", "required": false, - "type": "boolean" + "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" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists clusters by cluster type", + "description": "Whether this cluster is managed by cloudstack", "length": 255, - "name": "clustertype", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists clusters by Zone ID", + "description": "CPU arch of the clusters", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "type": "string" } ], "related": "", "response": [ { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the type of the cluster", + "description": "The type of the cluster", "name": "clustertype", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - {}, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the capacity of the Cluster", + "description": "The capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "The Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "The total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "The capacity type", + "name": "type", + "type": "short" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The Zone name", + "name": "zonename", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "The capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity name", + "description": "The capacity name", "name": "name", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The Pod ID", + "name": "podid", "type": "string" } ], "type": "list" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "CPU usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "The hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "The total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "CPU allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "The Zone name of the cluster", + "name": "zonename", + "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "The Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "State of the cluster", + "name": "state", "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Creates a user-defined VM backup schedule", - "isasync": false, - "name": "createBackupSchedule", - "params": [ + }, { - "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", - "length": 255, - "name": "quiescevm", - "required": false, - "since": "4.21.0", + "description": "The maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "The total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "Memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, + "description": "The total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", - "length": 255, - "name": "maxbackups", - "required": false, - "since": "4.21.0", - "type": "integer" + "description": "Running / total hosts in the cluster", + "name": "hosts", + "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "Memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", - "length": 255, - "name": "schedule", - "required": true, + "description": "The CPU overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" - } - ], - "related": "updateBackupSchedule,listBackups", - "response": [ + }, { - "description": "description for the backup", - "name": "description", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "The Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "domain id", - "name": "domainid", + "description": "The total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "Lists the vm specific details for the backup", - "name": "vmdetails", - "type": "map" + "description": "CPU allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "Indicates whether the VM from which the backup was taken is expunged or not", - "name": "isbackupvmexpunged", + "description": "CPU usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "Memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, + {}, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "The total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" }, + {}, + {}, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "Memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "The cluster ID", + "name": "id", "type": "string" }, { - "description": "zone name", - "name": "zone", + "description": "Whether this cluster is managed by Cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "The total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, - {}, { - "description": "backup type", - "name": "type", + "description": "The cluster name", + "name": "name", "type": "string" + } + ], + "since": "4.9.3" + }, + { + "description": "Creates a User-defined Instance backup schedule", + "isasync": false, + "name": "createBackupSchedule", + "params": [ + { + "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", + "length": 255, + "name": "maxbackups", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "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": "Interval type of the backup", + "description": "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, "name": "intervaltype", + "required": true, "type": "string" }, - {}, { - "description": "domain name", - "name": "domain", + "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": "external backup id", - "name": "externalid", + "description": "ID of the Instance for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" + } + ], + "related": "listBackupSchedule", + "response": [ + { + "description": "The time zone of the backup schedule", + "name": "timezone", "type": "string" }, { - "description": "backup date", - "name": "created", - "type": "date" + "description": "The time the backup is scheduled to be taken.", + "name": "schedule", + "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "The interval type of the backup schedule", + "name": "intervaltype", + "type": "intervaltype" + }, + {}, + { + "description": "Name of the Instance", + "name": "virtualmachinename", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "maximum number of backups retained", + "name": "maxbackups", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "quiesce the instance before checkpointing the disks for backup", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the VM backup", + "description": "ID of the backup schedule.", "name": "id", "type": "string" }, { - "description": "name of the backup", - "name": "name", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.14.0" @@ -9469,17 +9394,16 @@ "name": "listStoragePoolObjects", "params": [ { - "description": "id of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -9498,34 +9422,30 @@ "type": "string" }, { - "description": "", + "description": "id of the storage pool", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" } ], "related": "listImageStoreObjects", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Snapshot ID associated with the data store object.", "name": "snapshotid", "type": "string" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", + "type": "string" }, { "description": "Template ID associated with the data store object.", @@ -9533,10 +9453,11 @@ "type": "string" }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, + {}, { "description": "Size is in Bytes.", "name": "size", @@ -9547,32 +9468,36 @@ "name": "templatename", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, { - "description": "Name of the data store object.", - "name": "name", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Format of template associated with the data store object.", "name": "format", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Volume ID associated with the data store object.", "name": "volumeid", "type": "string" - }, - { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" } ], "since": "4.19.0" @@ -9583,136 +9508,136 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "", + "description": "The ID of the staging store", "length": 255, - "name": "page", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the staging store provider", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the staging store protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "The name of the staging store", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the staging store", + "description": "The staging store protocol", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the staging store", + "description": "The staging store provider", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the staging store", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "The Zone ID for the staging store", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "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 protocol of the image store", - "name": "protocol", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the image store", + "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 url of the image store", + "description": "The URL of the image store", "name": "url", "type": "string" }, { - "description": "the scope of the image store", + "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 name of the image store", + "name": "name", + "type": "string" }, - {}, { - "description": "the name of the image store", - "name": "name", + "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", + "description": "Defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the host's currently used disk size", + "description": "The host's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "the Zone ID of the image store", + "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 provider name of the image store", - "name": "providername", - "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 Zone name of the image store", + "name": "zonename", "type": "string" } ], @@ -9724,7 +9649,7 @@ "name": "startRouter", "params": [ { - "description": "the ID of the router", + "description": "The ID of the router", "length": 255, "name": "id", "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", @@ -9734,308 +9659,200 @@ ], "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ - {}, { - "description": "the guest IP address for the router", + "description": "The Network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The guest IP address for the router", "name": "guestipaddress", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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": "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 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": "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "The Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The hostname for the router", + "name": "hostname", "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 link local IP address for the router", - "name": "linklocalip", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "The public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The ID of the router", + "name": "id", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "The public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "Role of the domain router", + "name": "role", + "type": "string" }, + {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "The Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the version of template", - "name": "version", + "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 name of the router", + "name": "name", + "type": "string" }, - {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the first DNS for the router", + "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 corresponding guest network", - "name": "guestnetworkname", + "description": "The version of Template", + "name": "version", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "The project id of the IP address", + "name": "projectid", + "type": "string" + }, + { + "description": "The domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -10043,14 +9860,19 @@ "name": "healthcheckresults", "response": [ { - "description": "the type of the health check - basic or advanced", + "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 date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "The result of the health check if available", + "name": "success", + "type": "boolean" }, { "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", @@ -10058,156 +9880,259 @@ "type": "routerhealthstatus" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", + "description": "The name of the health check on the router", "name": "checkname", "type": "string" }, { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" } ], "type": "list" }, - { - "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": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, + {}, { "description": "path of the Domain the router belongs to", "name": "domainpath", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "The Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The Template name for the router", + "name": "templatename", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "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 name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "The list of NICs associated with the router", + "name": "nic", + "response": [ + { + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The 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 gateway of IPv6 Network", + "name": "ip6gateway", + "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 IP address of the NIC", + "name": "ipaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "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": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "CPU arch of the router", + "name": "arch", "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 version of scripts", + "name": "scriptsversion", "type": "string" } ] @@ -10218,147 +10143,147 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "The name of the configuration", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "The ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", + "description": "The ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "The ID of the Zone to reset the parameter value for corresponding zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "The ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "The ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "The ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ + {}, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "The component of the configuration", + "name": "component", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The possible options of the configuration value", + "name": "options", + "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", - "type": "string" + "description": "The value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "True if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "The name of the configuration", + "name": "name", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "The default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "The description of the configuration", + "name": "description", "type": "string" }, { - "description": "the category of the configuration", + "description": "The category of the configuration", "name": "category", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "Scope (zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "The type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The value of the configuration", + "name": "value", "type": "string" }, - {}, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "The name of the parent configuration", + "name": "parent", + "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "The subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "The display text of the configuration", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the group of the configuration", + "description": "The group of the configuration", "name": "group", "type": "string" } @@ -10366,19 +10291,33 @@ "since": "4.16.0" }, { - "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", + "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale Instance group.", "isasync": true, "name": "createAutoScalePolicy", "params": [ { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "The action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "The duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": true, + "type": "integer" + }, + { + "description": "The cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, "name": "quiettime", "required": false, "type": "integer" }, { - "description": "the name of the autoscale policy", + "description": "The name of the autoscale policy", "length": 255, "name": "name", "required": false, @@ -10386,100 +10325,86 @@ "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": true, - "type": "string" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "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 in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": true, - "type": "integer" } ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "The autoscale policy ID", + "name": "id", + "type": "string" }, + {}, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", + "description": "The duration for which the conditions have to be true before action is taken", + "name": "duration", "type": "integer" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "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", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "Name of the autoscale policy", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain name of the autoscale policy", + "name": "domain", + "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "The action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the 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 domain ID of the autoscale policy", - "name": "domainid", + "description": "The Account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "The project id autoscale policy", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the 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": "name of the autoscale policy", - "name": "name", + "description": "The domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" } ] @@ -10490,7 +10415,7 @@ "name": "deleteStratosphereSsp", "params": [ { - "description": "the host ID of ssp server", + "description": "The host ID of ssp server", "length": 255, "name": "hostid", "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", @@ -10500,24 +10425,24 @@ ], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "The 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -10531,42 +10456,42 @@ "related": "", "response": [ { - "description": "the state of the usage server", + "description": "The state of the usage server", "name": "state", "type": "state" }, { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The time these statistics were collected", + "name": "collectiontime", "type": "date" }, { - "description": "the name of the active usage server", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {}, { - "description": "the last time this Usage Server checked for jobs", + "description": "The last time this Usage Server checked for jobs", "name": "lastheartbeat", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", + "description": "The last time a usage job successfully completed", + "name": "lastsuccessfuljob", "type": "date" - } + }, + {} ], "since": "4.17.0" }, @@ -10585,383 +10510,376 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" }, { - "description": "Cleanups VM reservations in the database.", + "description": "Cleanups Instance reservations in the database.", "isasync": true, "name": "cleanVMReservations", "params": [], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "True 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } ] }, { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", "params": [ { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the name of the object store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the object store provider", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "provider", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "", + "description": "the ID of the Routing firewall rule", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], - "related": "addObjectStoragePool,updateObjectStoragePool", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the allocated size of the object store", - "name": "storageallocated", - "type": "long" - }, - { - "description": "the url of the object store", - "name": "url", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the name of the object store", - "name": "name", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the provider name of the object store", - "name": "providername", + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", - "params": [ - { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "description": "The Instance name for the port forwarding rule", + "name": "virtualmachinename", + "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 Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the ID of the Routing firewall rule", - "length": 255, + "description": "The ID of the port forwarding rule", "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", - "required": true, - "type": "uuid" - } - ], - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "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" - }, - { - "description": "the list of resource tags associated with the rule", + "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": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "tag key name", - "name": "key", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "Is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", + "description": "The Instance IP address for the port forwarding rule", "name": "vmguestip", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The 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 starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "The ending port of port forwarding rule's private port range", "name": "publicendport", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", + "params": [ + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "required": false, + "type": "uuid" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the name of the object store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the object store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addObjectStoragePool,updateObjectStoragePool", + "response": [ + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, - {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the name of the object store", + "name": "name", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "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 total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + {}, + {} ], - "since": "4.20.0" + "since": "4.19.0" }, { - "description": "create secondary staging store.", + "description": "Create secondary staging store.", "isasync": false, "name": "createSecondaryStagingStore", "params": [ { - "description": "the details for the staging store", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "The URL for the staging store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "the scope of the staging store: zone only for now", + "description": "The scope of the staging store: zone only for now", "length": 255, "name": "scope", "required": false, "type": "string" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the Zone ID for the staging store", + "description": "The Zone ID for the staging store", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -10969,7 +10887,14 @@ "type": "uuid" }, { - "description": "the staging store provider name", + "description": "The details for the staging store", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "The staging store provider name", "length": 255, "name": "provider", "required": false, @@ -10979,77 +10904,77 @@ "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "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 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 name of the image store", - "name": "name", + "description": "The provider name of the image store", + "name": "providername", "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 host's currently used disk size", + "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 URL of the image store", + "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "The name of the image store", + "name": "name", "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": "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": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - {} + "description": "The Zone ID of the image store", + "name": "zoneid", + "type": "string" + } ] }, { @@ -11067,27 +10992,27 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "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", + "description": "The 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" } ] }, @@ -11105,10 +11030,10 @@ "type": "uuid" }, { - "description": "ID of the instance", + "description": "Type of the resource", "length": 255, - "name": "resourceid", - "required": true, + "name": "resourcetype", + "required": false, "type": "string" }, { @@ -11119,18 +11044,24 @@ "type": "map" }, { - "description": "Type of the resource", + "description": "ID of the instance", "length": 255, - "name": "resourcetype", - "required": false, + "name": "resourceid", + "required": true, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "Name of the action", - "name": "name", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the action", + "name": "id", "type": "string" }, { @@ -11144,22 +11075,16 @@ "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the action", + "name": "name", "type": "string" }, {}, { - "description": "ID of the action", - "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.21.0" }, @@ -11169,7 +11094,15 @@ "name": "updateLBHealthCheckPolicy", "params": [ { - "description": "an optional field, whether to the display the policy 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": "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, "name": "fordisplay", "required": false, @@ -11183,177 +11116,169 @@ "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", "required": true, "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ { - "description": "the list of healthcheckpolicies", + "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 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", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "is policy for display to the regular user", + "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" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "Number of consecutive health check success before declaring an Instance healthy", "name": "healthcheckthresshold", "type": "int" }, { - "description": "the state of the policy", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "The description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "The state of the policy", "name": "state", "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": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "The pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" } ], "type": "list" }, - {}, - { - "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 UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "The ID of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "The LB rule ID", + "name": "lbruleid", "type": "string" } ], "since": "4.4" }, { - "description": "remove Tungsten-Fabric policy", + "description": "Remove Tungsten-Fabric policy", "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ { - "description": "the Uuid of Tungsten-Fabric policy rule", + "description": "The Uuid of Tungsten-Fabric policy rule", "length": 255, "name": "ruleuuid", "required": true, "type": "string" }, { - "description": "the Uuid of Tungsten-Fabric policy", + "description": "The ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "The Uuid of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "policyuuid", "required": true, - "type": "uuid" + "type": "string" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "list Tungsten-Fabric policy network name", + "description": "List Tungsten-Fabric policy network name", "name": "network", "type": "list" }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, {} ] }, @@ -11363,291 +11288,291 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the domain ID associated with the load balancer", + "description": "Zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "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": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "Name of the load balancer rule", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the public port from where the network traffic will be load balanced from", + "description": "Load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "publicport", + "name": "algorithm", "required": true, - "type": "integer" + "type": "string" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "description": "The source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "cidrlist", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "list" }, { - "description": "The protocol for the LB such as tcp, udp, tcp-proxy or ssl.", - "length": 255, - "name": "protocol", + "description": "The description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "The Account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "algorithm", - "required": true, - "type": "string" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "account", "required": false, "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "name of the load balancer rule", + "description": "The public port from where the network traffic will be load balanced from", "length": 255, - "name": "name", + "name": "publicport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "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": "cidrlist", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.18.0.0", - "type": "list" + "type": "uuid" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "The domain ID associated with the load balancer", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "The private port of the private IP address/Instance where the network traffic will be load balanced to", "length": 255, "name": "privateport", "required": true, "type": "integer" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "The protocol for the LB such as TCP, UDP, TCP-proxy or SSL.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "Public IP address ID from where the network traffic will be load balanced from", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" + }, + { + "description": "If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "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 name of the Load balancer", + "name": "name", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public port", - "name": "publicport", + "description": "The public IP address ID", + "name": "publicipid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "The project ID of the Load balancer", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The ID of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "The public port", + "name": "publicport", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 state of the rule", - "name": "state", + "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 of the load balancer rule", - "name": "domain", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "The description of the Load balancer", + "name": "description", "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" }, + {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "The Load balancer rule ID", + "name": "id", "type": "string" }, { - "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 public ip address id", - "name": "publicipid", + "description": "The domain ID of the Load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "The Account of the Load balancer rule", + "name": "account", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "The list of resource tags associated with Load balancer", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "list" }, - {} + { + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + {}, + { + "description": "The protocol of the Load Balancer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", + "type": "string" + } ] }, { @@ -11666,6 +11591,17 @@ ], "related": "quotaConfigureEmail", "response": [ + { + "description": "Whether the template is enabled.", + "name": "enabled", + "type": "boolean" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "The template's name.", "name": "templatename", @@ -11676,25 +11612,14 @@ "name": "minbalance", "type": "double" }, - { - "description": "Whether the template is enabled.", - "name": "enabled", - "type": "boolean" - }, { "description": "The configured account's id.", "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -11717,41 +11642,41 @@ ], "related": "listVsphereStoragePolicies", "response": [ + {}, { - "description": "the name of the Storage Policy", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "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 ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The description of the Storage Policy", + "name": "description", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "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 ID of the Storage Policy", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "The name of the Storage Policy", + "name": "name", "type": "string" } ] @@ -11772,24 +11697,24 @@ ], "response": [ { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -11802,7 +11727,7 @@ "name": "disableOutOfBandManagementForZone", "params": [ { - "description": "the ID of the zone", + "description": "The ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -11813,87 +11738,87 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "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", - "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", + "description": "The out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the ID of the host", + "description": "The ID of the host", "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "The out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "The out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "The out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "The operation result description", + "name": "description", + "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", + "description": "True if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - {}, - {}, - { - "description": "the out-of-band management interface address", - "name": "address", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "The out-of-band management interface port", + "name": "port", + "type": "string" + }, + {} ], "since": "4.9.0" }, { - "description": "Create VM backup", + "description": "Create Instance backup", "isasync": true, "name": "createBackup", "params": [ { - "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "description": "ID of the Instance", "length": 255, - "name": "quiescevm", - "required": false, - "since": "4.21.0", - "type": "boolean" + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { "description": "the name of the backup", @@ -11904,12 +11829,12 @@ "type": "string" }, { - "description": "ID of the VM", + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { "description": "the description for the backup", @@ -11921,518 +11846,259 @@ } ], "response": [ + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.14.0" }, { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.", "length": 255, - "name": "account", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the System VM", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, "type": "uuid" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "The second DNS for the System VM", + "name": "dns2", + "type": "string" }, { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "The Zone ID for the System VM", + "name": "zoneid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "The gateway for the System VM", + "name": "gateway", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "The ID of the System VM", + "name": "id", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", - "required": false, - "type": "uuid" + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "The Pod ID for the System VM", + "name": "podid", "type": "string" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", - "response": [ + }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" - }, - { - "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 public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the VM 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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", + "description": "The state of the System VM", "name": "state", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - {}, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "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 private port range", - "name": "privateport", - "type": "string" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "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 agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The private IP address for the System VM", + "name": "privateip", "type": "string" }, { - "description": "public vlan range", + "description": "Public VLAN range", "name": "publicvlan", "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The Pod name for the System VM", + "name": "podname", "type": "string" }, { - "description": "the host ID for the system VM", + "description": "The host ID for the System VM", "name": "hostid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "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 first DNS for the system VM", - "name": "dns1", + "description": "Guest VLAN range", + "name": "guestvlan", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "The link local MAC address for the System VM", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "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 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 hostname for the system VM", - "name": "hostname", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the link local IP address for the system vm", + "description": "The Control 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 date and time the system VM was created", + "description": "The date and time the System VM was created", "name": "created", "type": "date" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "The Zone name for the System VM", + "name": "zonename", "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", + "description": "The systemvm agent version", + "name": "version", "type": "string" }, + {}, { - "description": "the public IP address for the system VM", + "description": "The public IP address for the System VM", "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the state of the system VM", - "name": "state", - "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 hostname for the System VM", + "name": "hostname", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "The Template ID for the System VM", + "name": "templateid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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 public netmask for the system VM", - "name": "publicnetmask", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The public MAC address for the System VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "The Template name for the System VM", + "name": "templatename", "type": "string" } ] @@ -12443,33 +12109,33 @@ "name": "deleteEgressFirewallRule", "params": [ { - "description": "the ID of the firewall rule", + "description": "The ID of the firewall rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,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": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, @@ -12482,15 +12148,7 @@ "name": "updateVPC", "params": [ { - "description": "the id of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "MTU to be configured on the Network VR's public facing interfaces", "length": 255, "name": "publicmtu", "required": false, @@ -12498,117 +12156,221 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "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 name of the VPC", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "the display text of the VPC", + "description": "Optional field, should we display the VPC to the end User or not", "length": 255, - "name": "displaytext", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the VPC", + "description": "The display text of the VPC", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "description": "IPV4 address to be assigned to the public interface of the Network router. This address must already be acquired for this VPC", "length": 255, "name": "sourcenatipaddress", "required": false, "since": "4.19", "type": "string" + }, + { + "description": "The ID of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the second IPv6 DNS for the VPC", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "The first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "The second IPv6 DNS for the VPC", "name": "ip6dns2", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "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", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "VPC offering ID the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "The owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "The domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "The project ID of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "True if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, { - "description": "is vpc for display to the regular user", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "The date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "Is VPC for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "If this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, {}, { - "description": "an alternate display text of the VPC.", + "description": "The ID of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "An alternate display text of the VPC.", "name": "displaytext", "type": "string" }, { - "description": "the list of supported services", + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + {}, + { + "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 Network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the service provider name", + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The service provider name", "name": "provider", "response": [ { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "UUID of the Network provider", + "name": "id", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "The provider name", + "name": "name", + "type": "string" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "State of the Network provider", + "name": "state", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "services for this provider", + "description": "Services for this provider", "name": "servicelist", "type": "list" } @@ -12616,28 +12378,23 @@ "type": "list" }, { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", + "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", + "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" @@ -12646,256 +12403,417 @@ "type": "list" }, { - "description": "the project id of the VPC", - "name": "projectid", + "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", + "description": "The list of Networks belonging to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "True VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "The first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "State of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "The name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "Does VPC use distributed router for one hop forwarding and host based Network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "VPC offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "The domain ID of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "the list of resource tags associated with the project", + "description": "The list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "tag value", + "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": "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 project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" + } + ] + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "params": [ + { + "description": "List IPV6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "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 cidr the VPC", - "name": "cidr", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "List only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "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 Instances", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "List IPV6 firewall rules by Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Lists IPv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + { + "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the VPC", - "name": "id", + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "The public IP address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "The ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "The ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, - {}, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "The Instance IP address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "The protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "The starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "The Instance name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "The ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "The state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" + }, + { + "description": "Is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, { - "description": "List VM Schedules.", + "description": "List Instance Schedules.", "isasync": false, "name": "listVMSchedule", "params": [ { - "description": "ID of VM schedule", + "description": "", "length": 255, - "name": "enabled", + "name": "pagesize", "required": false, - "type": "boolean" - }, - { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "ID of Instance schedule", "length": 255, - "name": "page", + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -12905,39 +12823,41 @@ "type": "string" }, { - "description": "Action taken by schedule", + "description": "", "length": 255, - "name": "action", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "ID of VM schedule", + "description": "ID of the Instance for which schedule is to be defined", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "", + "description": "ID of Instance schedule", "length": 255, - "name": "pagesize", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "Action taken by schedule", + "length": 255, + "name": "action", + "required": false, + "type": "string" } ], "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "Cron formatted Instance schedule", + "name": "schedule", + "type": "string" }, { "description": "Timezone of the schedule", @@ -12945,52 +12865,57 @@ "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Description of Instance schedule", + "name": "description", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, - {}, { - "description": "Description of VM schedule", - "name": "description", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of Instance schedule", + "name": "id", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "ID of Instance", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - } + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + {} ], "since": "4.19.0" }, @@ -13007,7 +12932,7 @@ "type": "boolean" }, { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "description": "Patches System VM - CPVM/SSVM with the specified ID", "length": 255, "name": "id", "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", @@ -13016,27 +12941,27 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.17.0" @@ -13050,10 +12975,17 @@ "description": "comma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS)", "length": 255, "name": "nodeids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "list" }, + { + "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", + "length": 255, + "name": "mountcksisoonvr", + "required": false, + "type": "boolean" + }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -13063,13 +12995,6 @@ "since": "4.21.0", "type": "uuid" }, - { - "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", - "length": 255, - "name": "mountcksisoonvr", - "required": false, - "type": "boolean" - }, { "description": "(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation", "length": 255, @@ -13081,54 +13006,45 @@ "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "The ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "The ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, + {}, { - "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", + "type": "string" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -13136,201 +13052,210 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "The project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", + "description": "The list of virtualmachines associated with this Kubernetes cluster", "name": "virtualmachines", "type": "list" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "The description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", + "description": "The name of the network of the Kubernetes cluster", "name": "associatednetworkname", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "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 etcd nodes on the Kubernetes cluster", "name": "etcdofferingname", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", + "description": "The name of the domain in which the Kubernetes cluster exists", "name": "domain", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", - "type": "string" + "description": "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "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 Account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, - {}, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "The control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "The name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" + "description": "The name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, + {}, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "The cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "The memory the Kubernetes cluster", + "name": "memory", "type": "string" }, - {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { "description": "ID of CNI Configuration associated with the cluster", "name": "cniconfigurationid", "type": "string" + }, + { + "description": "The state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" } ], "since": "4.21.0" @@ -13341,7 +13266,21 @@ "name": "listVolumesMetrics", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "The type of disk volume", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "displayvolume", "required": false, @@ -13349,75 +13288,81 @@ "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "List volumes on specified host", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.19.1", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "The ID of the Instance", "length": 255, - "name": "state", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "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": "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,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list volumes on specified host", + "description": "The ID of the disk volume", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "id", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, { - "description": "the type of disk volume", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "List system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" + }, { "description": "", "length": 255, @@ -13434,67 +13379,56 @@ "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "List volumes by disk offering", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "The ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "ids", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "the cluster id the disk volume belongs to", + "description": "List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "listall", + "name": "ids", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "The pod ID the disk volume belongs to", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.3", - "type": "string" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -13504,40 +13438,31 @@ "type": "map" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the pod id the disk volume belongs to", + "description": "The name of the disk volume", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "listsystemvms", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "", + "description": "The cluster ID the disk volume belongs to", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" } @@ -13545,407 +13470,347 @@ "related": "", "response": [ { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Max IOPS of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "The Instance'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": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "The bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the project id of the vpn", + "description": "The project id of the VPN", "name": "projectid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "Pod id of the volume", + "name": "podid", "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": "name of the virtual machine", - "name": "vmname", - "type": "string" + "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", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - {}, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the list of resource tags associated", + "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", + "description": "The boolean state of whether the volume is destroyed or not", "name": "destroyed", "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "The total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "name of the disk volume", - "name": "name", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Name of the Instance", + "name": "vmname", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "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 date the volume was attached to an Instance", + "name": "attached", "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { @@ -13954,72 +13819,132 @@ "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "Disk size in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "The project name of the VPN", + "name": "project", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "The date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "Name of the disk volume", + "name": "name", "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.9.3" }, { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "description": "Lists all possible details and their options for a resource type such as an Instance or a Template", "isasync": false, "name": "listDetailOptions", "params": [ { - "description": "the UUID of the resource (optional)", + "description": "The resource type such as UserVm, Template etc.", "length": 255, - "name": "resourceid", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the resource type such as UserVm, Template etc.", + "description": "The UUID of the resource (optional)", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "Map of all possible details and their possible list of values", "name": "details", "type": "map" }, - {} + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.13" }, @@ -14029,34 +13954,34 @@ "name": "listSslCerts", "params": [ { - "description": "Load balancer rule ID", + "description": "ID of SSL certificate", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "description": "Account ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "ID of SSL certificate", + "description": "Load balancer rule ID", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" } @@ -14064,71 +13989,71 @@ "related": "uploadSslCert", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain id of the Network owner", + "name": "domainid", + "type": "string" }, + {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "Account for the certificate", + "name": "account", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "The project name of the certificate", + "name": "project", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "Certificate", + "name": "certificate", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "The project id of the certificate", + "name": "projectid", + "type": "string" }, { - "description": "name", - "name": "name", + "description": "The domain name of the Network owner", + "name": "domain", "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", + "description": "Certificate chain", + "name": "certchain", "type": "string" }, {}, { - "description": "certificate chain", - "name": "certchain", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Name", + "name": "name", "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" } ] }, @@ -14138,94 +14063,94 @@ "name": "listPrivateGateways", "params": [ { - "description": "list private gateway 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": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list gateways by ip address", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list gateways by state", + "description": "List private gateway by ID", "length": 255, - "name": "state", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List gateways by VPC", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List gateways by state", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list gateways by vlan", + "description": "", "length": 255, - "name": "vlan", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list gateways by vpc", + "description": "List gateways by IP address", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List gateways by VLAN", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", @@ -14236,110 +14161,110 @@ "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "Zone ID of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "The ID of the private gateway", + "name": "id", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "ACL ID set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "The private gateway's IP address", + "name": "ipaddress", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "The project name of the private gateway", + "name": "project", "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 name of the zone the private gateway belongs to", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "The ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "Path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "The private gateway's netmask", + "name": "netmask", "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 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": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "VPC ID the private gateway belongs to", + "name": "vpcid", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The Network implementation uri for the private gateway", + "name": "vlan", "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 private gateway", + "name": "account", + "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { @@ -14348,29 +14273,29 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The gateway", + "name": "gateway", + "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "The project ID of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, { - "description": "Update the default Ip of a VM Nic", + "description": "Update the default IP of an Instance NIC", "isasync": true, "name": "updateVmNicIp", "params": [ { - "description": "the ID of the nic to which you want to assign private IP", + "description": "The ID of the NIC to which you want to assign private IP", "length": 255, "name": "nicid", "related": "listNics", @@ -14385,163 +14310,87 @@ "type": "string" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total number of network traffic bytes received", + "description": "The total number of Network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the VM's disk read in KiB", + "description": "The Instance's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "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 name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "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 Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the VM's primary IP address", @@ -14549,510 +14398,406 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "The name of the affinity group", + "name": "name", "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 description of the affinity group", + "name": "description", "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 project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 type of the nic", - "name": "type", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The number of Instances associated with this Security Group", + "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", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", + "description": "The name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "The ID of the security group", "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } @@ -15060,244 +14805,229 @@ "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "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", + "description": "The protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the ending IP of the security group rule ", + "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" } ], "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 name of the security group", - "name": "domain", + "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 ID of the security group", - "name": "domainid", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", + "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", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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", + "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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" }, { - "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 domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "set" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The group name of the Instance", + "name": "group", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -15305,736 +15035,936 @@ "type": "resourceiconresponse" }, { - "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": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, - {}, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "The IP address of the NIC", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "The 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 CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The target memory in Instance (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", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the host for the Instance", + "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": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "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 service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "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": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the Pod ID for the router", - "name": "podid", - "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", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, - {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, - {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" + } + ] + }, + { + "description": "Starts an existing Internal LB Instance.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ + { + "description": "The ID of the Internal LB Instance", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "The date and time the router was created", + "name": "created", + "type": "date" }, { - "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 result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "The type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "The result of the health check if available", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, + {}, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the state of redundant virtual router", + "description": "The state of redundant virtual router", "name": "redundantstate", "type": "string" }, { - "description": "true if any health checks had failed", + "description": "True if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The Network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The Account associated with the router", + "name": "account", "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": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "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 link local IP address for the router", - "name": "linklocalip", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of nics associated with the router", + "description": "The list of NICs associated with the router", "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "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 extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the netmask of the nic", + "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 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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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", + "description": "The type of the NIC", + "name": "type", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 Instance", + "name": "deviceid", "type": "string" } ], "type": "set" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the second DNS for the router", + "description": "The host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "The second DNS for the router", "name": "dns2", "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 project name of the address", - "name": "project", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "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", "type": "string" }, { - "description": "the second IPv6 DNS for the router", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "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 guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "The second IPv6 DNS for the router", "name": "ip6dns2", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", + "description": "The state of the router", + "name": "state", + "type": "state" + }, + { + "description": "The project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "The first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "The name of the router", + "name": "name", + "type": "string" + }, + { + "description": "The Zone ID for the router", + "name": "zoneid", + "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 version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "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 link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "Role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "The Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "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" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "The Template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "The guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the version of template", + "description": "The version of Template", "name": "version", "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 state of the router", - "name": "state", - "type": "state" + "description": "The domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "The version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The Control IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "The Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "The ID of the router", + "name": "id", + "type": "string" + }, + { + "description": "The hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "The project id of the IP address", + "name": "projectid", "type": "string" } ] @@ -16045,154 +15975,147 @@ "name": "updateDiskOffering", "params": [ { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "state of the disk offering", - "length": 255, - "name": "state", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "bytesreadrate", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "I/O requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "the cache mode to use for this disk offering", + "description": "state of the disk offering", "length": 255, - "name": "cachemode", + "name": "state", "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": "iopswriteratemaxlength", + "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", + "description": "Updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "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, "since": "4.15", "type": "long" }, { - "description": "updates alternate display text of the disk offering with this value", + "description": "The ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, - "name": "displaytext", + "name": "domainid", "required": false, + "since": "4.13", "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": "burst requests read rate of the disk offering", + "description": "Sort key of the disk offering, integer", "length": 255, - "name": "iopsreadratemax", + "name": "sortkey", "required": false, - "since": "4.15", - "type": "long" + "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, "since": "4.15", "type": "long" }, { - "description": "sort key of the disk offering, integer", + "description": "The cache mode to use for this disk offering", "length": 255, - "name": "sortkey", + "name": "cachemode", "required": false, - "type": "integer" + "since": "4.15", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "Bytes read rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "Burst io requests write rate of the disk offering", "length": 255, - "name": "displayoffering", + "name": "iopswriteratemax", "required": false, - "type": "boolean" + "since": "4.15", + "type": "long" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "Length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", "required": false, - "since": "4.13", - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "Burst bytes write rate of the disk offering", "length": 255, - "name": "tags", + "name": "byteswriteratemax", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "Bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "io requests read rate of the disk offering", + "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": "I/O requests read rate of the disk offering", "length": 255, "name": "iopsreadrate", "required": false, @@ -16200,224 +16123,231 @@ "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "Length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemax", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "Updates name of the disk offering with this value", "length": 255, - "name": "byteswriteratemaxlength", + "name": "name", "required": false, - "since": "4.15", - "type": "long" + "type": "string" } ], "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "state of the disk offering", - "name": "state", + "description": "Burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "The vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" + }, + {}, + { + "description": "Length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "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": "I/O requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "Unique ID of the disk offering", + "name": "id", "type": "string" }, + {}, { - "description": "burst bytes write rate of the disk offering", + "description": "Burst bytes write rate of the disk offering", "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "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", - "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 bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "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": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "Additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, - {}, { - "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": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "The max IOPS of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "state of the disk offering", + "name": "state", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "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 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", - "type": "string" + "description": "Bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "Length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "True if disk offering uses custom IOPS, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "The tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "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 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": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "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": "diskBytesReadRateMaxLength", - "type": "long" + "description": "The date this disk offering was created", + "name": "created", + "type": "date" }, { - "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": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "An alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "the name of the disk offering", + "description": "The name of the disk offering", "name": "name", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "I/O requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" } ] @@ -16428,20 +16358,11 @@ "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "description": "the IDs of the VMs to remove from the cluster", + "description": "List by keyword", "length": 255, - "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "list" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -16451,11 +16372,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "The IDs of the VMs to remove from the cluster", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "virtualmachineids", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "list" }, { "description": "", @@ -16463,47 +16385,55 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "The ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "true if operation is executed successfully", + "description": "True 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the id of the Kubernetes cluster", + "description": "The ID of the Kubernetes cluster", "name": "id", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" }, { - "description": "delete Tungsten-Fabric logical router", + "description": "Delete Tungsten-Fabric logical router", "isasync": true, "name": "deleteTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -16511,7 +16441,7 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "The uuid of Tungsten-Fabric logical router", "length": 255, "name": "logicalrouteruuid", "required": true, @@ -16520,36 +16450,36 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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": "Reset site to site vpn connection", + "description": "Reset site to site VPN connection", "isasync": true, "name": "resetVpnConnection", "params": [ { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for connection. If the Account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", @@ -16557,163 +16487,163 @@ "type": "uuid" }, { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "id of vpn connection", + "description": "ID of VPN connection", "length": 255, "name": "id", "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", "required": true, "type": "uuid" + }, + { + "description": "An optional Account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "Is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "The public IP address", + "name": "publicip", "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "The VPN gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the project name", - "name": "project", + "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", + "description": "The owner", + "name": "account", "type": "string" }, - {}, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "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 customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the connection ID", + "description": "The connection ID", "name": "id", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "If DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the owner", - "name": "account", + "description": "State of VPN connection", + "name": "state", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "The project name", + "name": "project", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, - {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "State of VPN connection", + "name": "passive", + "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" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Public IP address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "The domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ] @@ -16724,39 +16654,23 @@ "name": "listKubernetesClusters", "params": [ { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "State of the Kubernetes cluster", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "state of the Kubernetes cluster", + "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": "state", + "name": "name", "required": false, "type": "string" }, @@ -16775,58 +16689,74 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "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.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "The ID of the Kubernetes cluster", "length": 255, - "name": "clustertype", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "List only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", + "type": "string" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "The name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { @@ -16835,84 +16765,79 @@ "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "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 project name of the Kubernetes cluster", + "name": "project", + "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 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 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 cpu cores of the Kubernetes cluster", + "description": "The cpu cores of the Kubernetes cluster", "name": "cpunumber", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "The ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "The name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "the number of the etcd nodes on the Kubernetes cluster", @@ -16920,105 +16845,110 @@ "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" + }, + {}, + { + "description": "The list of virtualmachines associated with this Kubernetes cluster", "name": "virtualmachines", "type": "list" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "The Account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "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 Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", "name": "csienabled", "type": "boolean" }, - {}, - {}, { - "description": "keypair details", - "name": "keypair", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "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 name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "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" }, { @@ -17027,107 +16957,99 @@ "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "The name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "The memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "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 ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "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", + "description": "The name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" } ] }, { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "description": "Creates and automatically starts an Instance based on a service offering, disk offering, and Template.", "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": "the ID of the load balancer rule", + "description": "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "minmembers", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "The name of the autoscale Instance Group", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "The frequency in which the performance counters to be collected", "length": 255, - "name": "maxmembers", - "required": true, + "name": "interval", + "required": false, "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.", "length": 255, - "name": "minmembers", + "name": "maxmembers", "required": true, "type": "integer" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "The autoscale profile that contains information about the Instances in the Instance group.", "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "An optional field, whether to the display the group to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", + "description": "List of scaledown autoscale policies", "length": 255, "name": "scaledownpolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", @@ -17135,7 +17057,15 @@ "type": "list" }, { - "description": "list of scaleup autoscale policies", + "description": "The ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "List of scaleup autoscale policies", "length": 255, "name": "scaleuppolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", @@ -17146,153 +17076,262 @@ "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "The autoscale profile that contains information about the Instances in the Instance group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project id of the Instance group", + "name": "projectid", + "type": "string" + }, + { + "description": "The name of the autoscale Instance group ", + "name": "name", + "type": "string" + }, + { + "description": "List of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "The id of the guest Network the LB rule belongs to", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "The public IP address ID", + "name": "publicipid", + "type": "string" + }, + { + "description": "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "list of scaleup autoscale policies", + "description": "List of scaleup autoscale policies", "name": "scaleuppolicies", "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "The autoscale Instance group ID", + "name": "id", + "type": "string" + }, + { + "description": "Is group for display to the regular User", + "name": "fordisplay", "type": "boolean" }, { - "description": "the public ip address", - "name": "publicip", + "description": "The LB provider of the guest Network the LB rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "The project name of the Instance group", + "name": "project", + "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "The public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", + "description": "The Load balancer rule ID", "name": "lbruleid", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "The public port", + "name": "publicport", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "The current state of the AutoScale Instance Group", + "name": "state", "type": "string" }, { - "description": "the domain ID of the vm group", + "description": "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "The domain ID of the Instance group", "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.", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.", "name": "minmembers", "type": "int" }, + {}, + {}, + { + "description": "The name of the guest Network the LB rule belongs to", + "name": "associatednetworkname", + "type": "string" + }, { - "description": "the date when this vm group was created", + "description": "The date when this Instance group was created", "name": "created", "type": "date" + } + ] + }, + { + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", + "params": [ + { + "description": "UUID of the VPC which the Bgp Peers are associated to.", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, - {}, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "required": false, "type": "list" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, {}, { - "description": "the public port", - "name": "publicport", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Deletes a load balancer rule.", @@ -17300,10 +17339,10 @@ "name": "deleteLoadBalancerRule", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -17311,47 +17350,33 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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": "add a baremetal ping pxe server", + "description": "Add a baremetal ping PXE server", "isasync": true, "name": "addBaremetalPxePingServer", "params": [ - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" - }, { "description": "Root directory on PING storage server", "length": 255, @@ -17360,14 +17385,7 @@ "type": "string" }, { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", @@ -17375,23 +17393,23 @@ "type": "uuid" }, { - "description": "PING storage server ip", + "description": "URL of the external pxe device", "length": 255, - "name": "pingstorageserverip", + "name": "url", "required": true, "type": "string" }, { - "description": "Username of PING storage server", + "description": "Type of pxe device", "length": 255, - "name": "pingcifsusername", - "required": false, + "name": "pxeservertype", + "required": true, "type": "string" }, { "description": "Credentials to reach external pxe device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -17403,183 +17421,95 @@ "required": false, "type": "uuid" }, - { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": "Password of PING storage server", "length": 255, "name": "pingcifspassword", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "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": "Root directory on PING storage server", - "name": "pingdir", - "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "url", - "name": "url", - "type": "string" - }, - { - "description": "PING storage server ip", + "description": "PING storage server IP", + "length": 255, "name": "pingstorageserverip", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "device id of ", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Change the BGP peers for a VPC.", - "isasync": true, - "name": "changeBgpPeersForVpc", - "params": [ - { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "description": "Username of PING storage server", "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "name": "pingcifsusername", "required": false, - "type": "list" + "type": "string" }, { - "description": "UUID of the VPC which the Bgp Peers are associated to.", + "description": "TFTP root directory of PXE server", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "tftpdir", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "related": "", "response": [ { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - {}, - { - "description": "password of bgp peer", - "name": "password", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { - "description": "id of the bgp peer", + "description": "Device ID of ", "name": "id", "type": "string" }, - {}, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the project id of the bgp peer", - "name": "projectid", - "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": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "the project name of the bgp peer", - "name": "project", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, + {}, { - "description": "name of zone to which the bgp peer 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 account of the bgp peer", - "name": "account", + "description": "PING storage server ip", + "name": "pingstorageserverip", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "URL", + "name": "url", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "The physical Network to which this external DHCP device belongs to", + "name": "physicalnetworkid", "type": "string" - }, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ], - "since": "4.20.0" + ] }, { - "description": "list portable IP ranges", + "description": "List portable IP ranges", "isasync": false, "name": "listPortableIpRanges", "params": [ @@ -17592,11 +17522,11 @@ "type": "uuid" }, { - "description": "Id of a Region", + "description": "List by keyword", "length": 255, - "name": "regionid", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -17613,159 +17543,159 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Id of a Region", "length": 255, - "name": "keyword", + "name": "regionid", "required": false, - "type": "string" + "type": "integer" } ], "related": "createPortableIpRange", "response": [ { - "description": "the start ip of the portable IP range", + "description": "The start IP of the portable IP range", "name": "startip", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "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", + "description": "The ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "The end IP of the portable IP range", + "name": "endip", "type": "string" }, {}, { - "description": "the end ip of the portable IP range", - "name": "endip", + "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 gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "public IP address", - "name": "ipaddress", + "description": "The ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "The Account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "The domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", - "type": "string" + "description": "Date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "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 ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "VPC the IP belongs to", + "name": "vpcid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "Public IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "The ID of the Network where IP belongs to", + "name": "networkid", "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": "Returns user data associated with the VM", + "description": "Returns user data associated with the Instance", "isasync": false, "name": "getVirtualMachineUserData", "params": [ { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 encoded Instance User Data", + "name": "userdata", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the ID of the virtual machine", + "description": "The ID of the Instance", "name": "virtualmachineid", "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -17775,22 +17705,22 @@ "name": "createNetworkPermissions", "params": [ { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "A comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "accounts", "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": "A comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "A comma delimited list of 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", @@ -17798,7 +17728,7 @@ "type": "list" }, { - "description": "the network ID", + "description": "The network ID", "length": 255, "name": "networkid", "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", @@ -17809,25 +17739,25 @@ "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" @@ -17838,7 +17768,7 @@ "name": "disableStaticNat", "params": [ { - "description": "the public IP address ID for which static NAT feature is being disabled", + "description": "The public IP address ID for which static NAT feature is being disabled", "length": 255, "name": "ipaddressid", "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -17847,27 +17777,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": "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", + "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" } ] }, @@ -17884,7 +17814,7 @@ "type": "string" }, { - "description": "the ID of the nic to which you want to assign private IP", + "description": "The ID of the NIC to which you want to assign private IP", "length": 255, "name": "nicid", "related": "listNics", @@ -17894,46 +17824,46 @@ ], "related": "", "response": [ - { - "description": "the ID of the network", - "name": "networkid", - "type": "string" - }, {}, { - "description": "the list of Secondary ipv4 addr of nic", + "description": "The list of Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the secondary private IP addr", - "name": "id", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the vm", + "description": "The ID of the Instance", "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the nic", + "description": "The ID of the NIC", "name": "nicid", "type": "string" }, + {}, + { + "description": "The ID of the secondary private IP addr", + "name": "id", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the Network", + "name": "networkid", "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -17944,35 +17874,34 @@ "name": "quotaTariffUpdate", "params": [ { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "description": "Quota tariff's name", "length": 65535, - "name": "activationrule", - "required": false, + "name": "name", + "required": true, "since": "4.18.0.0", "type": "string" }, { - "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, - "since": "4.18.0.0", "type": "date" }, { - "description": "Position in the execution sequence for tariffs of the same type", + "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "position", + "name": "enddate", "required": false, - "since": "4.20.0.0", - "type": "integer" + "since": "4.18.0.0", + "type": "date" }, { - "description": "DEPRECATED. Integer value for the usage type of the resource", + "description": "The quota tariff value of the resource as per the default unit.", "length": 255, - "name": "usagetype", + "name": "value", "required": false, - "type": "integer" + "type": "double" }, { "description": "Quota tariff's description. Inform empty to remove the description.", @@ -17983,116 +17912,117 @@ "type": "string" }, { - "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "startdate", + "name": "position", "required": false, - "type": "date" + "since": "4.20.0.0", + "type": "integer" }, { - "description": "Quota tariff's name", - "length": 65535, - "name": "name", - "required": true, - "since": "4.18.0.0", - "type": "string" + "description": "DEPRECATED. Integer value for the usage type of the resource", + "length": 255, + "name": "usagetype", + "required": false, + "type": "integer" }, { - "description": "The quota tariff value of the resource as per the default unit.", - "length": 255, - "name": "value", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", "required": false, - "type": "double" + "since": "4.18.0.0", + "type": "string" } ], "related": "quotaTariffList,quotaTariffCreate", "response": [ { - "description": "the start date of the quota tariff", - "name": "effectiveDate", + "description": "When the quota tariff was removed", + "name": "removed", "type": "date" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "The ID of the tariff", + "name": "id", "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" - }, - { - "description": "position in the execution sequence for tariffs of the same type", + "description": "Position in the execution sequence for tariffs of the same type", "name": "position", "type": "integer" }, { - "description": "name", - "name": "name", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "usageName", + "name": "usageName", + "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "Currency", + "name": "currency", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "Description", + "name": "description", "type": "string" }, + {}, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "usage type description", + "description": "Usage type description", "name": "usageTypeDescription", "type": "string" }, { - "description": "description", - "name": "description", + "description": "Name", + "name": "name", "type": "string" }, { - "description": "usageName", - "name": "usageName", + "description": "Activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the ID of the tariff", - "name": "id", - "type": "string" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, - {}, { - "description": "when the quota tariff was removed", - "name": "removed", + "description": "The start date of the quota tariff", + "name": "effectiveDate", "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The end date of the quota tariff", + "name": "endDate", + "type": "date" } ], "since": "4.7.0" @@ -18103,7 +18033,7 @@ "name": "deleteUcsManager", "params": [ { - "description": "ucs manager id", + "description": "Ucs manager ID", "length": 255, "name": "ucsmanagerid", "related": "listUcsManagers,addUcsManager", @@ -18112,28 +18042,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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -18142,96 +18072,96 @@ "name": "deleteHost", "params": [ { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "The host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "Force destroy local storage on this host. All Instances created on this local storage will be destroyed", "length": 255, "name": "forcedestroylocalstorage", "required": false, "type": "boolean" }, { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "description": "Force delete the host. All HA enabled Instances 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, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the current status of the latest async job acting on this object", + "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", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" } ] }, { - "description": "deletes the resource icon from the specified resource(s)", + "description": "Deletes the resource icon from the specified resource(s)", "isasync": false, "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 UUID of the latest async job acting on 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", + "description": "Any text associated with the 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.16.0.0" }, @@ -18243,18 +18173,8 @@ "related": "", "response": [ { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" - }, - { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", - "type": "boolean" - }, - { - "description": "true if additional configurations or extraconfig can be passed to Instances", - "name": "additionalconfigenabled", + "description": "If invitation confirmation is required when add Account to project", + "name": "projectinviterequired", "type": "boolean" }, { @@ -18263,34 +18183,44 @@ "type": "string" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "True if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, + { + "description": "Time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" + }, { "description": "Max allowed number of api requests within the specified interval", "name": "apilimitmax", "type": "integer" }, { - "description": "true if users are allowed to force stop a vm, false otherwise", - "name": "allowuserforcestopvm", + "description": "true if dynamically scaling for instances is enabled", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", + "description": "True if stats are collected only for User Instances, false if System VM stats are also collected", + "name": "instancesstatsuseronly", "type": "boolean" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" + "description": "true if instance lease feature is enabled", + "name": "instanceleaseenabled", + "type": "boolean" + }, + { + "description": "Minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" }, { "description": "the min Ram size for the service offering used by the shared filesystem instance", @@ -18298,59 +18228,63 @@ "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the User can recover and expunge Instances, false otherwise", + "name": "allowuserexpungerecovervm", + "type": "boolean" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" + "description": "True to show the parent and chain size (sum of physical size of snapshot and all its parents) for incremental snapshots", + "name": "snapshotshowchainsize", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if Users can see all Accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", + "description": "True if stats are retained for Instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", + "description": "True if user and domain admins can set Templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "True if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" + "description": "True if Snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", + "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", + "description": "The retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" + }, + { + "description": "True if region supports elastic Load balancer on basic zones", "name": "supportELB", "type": "string" }, { - "description": "true if dynamically scaling for instances is enabled", - "name": "dynamicscalingenabled", + "description": "True if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "True if regular User is allowed to create projects", + "name": "allowusercreateprojects", "type": "boolean" }, { @@ -18359,61 +18293,62 @@ "type": "string" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", + "description": "Default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", "type": "long" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" - }, - { - "description": "the min CPU count for the service offering used by the shared filesystem instance", - "name": "sharedfsvmmincpucount", + "description": "The retention time for Instances stats", + "name": "instancesstatsretentiontime", "type": "integer" }, { - "description": "true if instance lease feature is enabled", - "name": "instanceleaseenabled", + "description": "True if the User is allowed to view the destroyed Instances, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if additional configurations or extraconfig can be passed to Instances", + "name": "additionalconfigenabled", "type": "boolean" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", + "type": "integer" }, + {}, { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", + "description": "True if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" }, + {}, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", "type": "boolean" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", + "description": "True if the User can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "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": "securitygroupsenabled", - "type": "boolean" + "description": "Version of the CloudStack", + "name": "cloudstackversion", + "type": "string" }, - {} + { + "description": "True if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" + } ] }, { @@ -18422,7 +18357,7 @@ "name": "releaseDedicatedZone", "params": [ { - "description": "the ID of the Zone", + "description": "The ID of the Zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -18431,28 +18366,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", + "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", + "description": "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" + } ] }, { @@ -18460,6 +18395,13 @@ "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, @@ -18468,70 +18410,63 @@ "type": "string" }, { - "description": "network service provider id", + "description": "Network service provider ID", "length": 255, "name": "id", "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": "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": "uuid of the network provider", - "name": "id", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "State of the Network provider", + "name": "state", "type": "string" }, - {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "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 destination physical network", + "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The provider name", + "name": "name", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -18544,7 +18479,7 @@ "description": "The ID of the volume", "length": 255, "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, @@ -18556,380 +18491,405 @@ "type": "string" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "Size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "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 Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the Instance", + "name": "virtualmachineid", "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": "max iops of the disk volume", - "name": "maxiops", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "The project name of the VPN", + "name": "project", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "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": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "The path of the volume", + "name": "path", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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 an Instance", + "name": "attached", + "type": "date" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "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": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "True if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "set" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "provisioning type used to create volumes.", + "description": "Provisioning type used to create volumes.", "name": "provisioningtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { @@ -18938,48 +18898,23 @@ "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 alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Pod id of the volume", + "name": "podid", "type": "string" } ], @@ -18991,19 +18926,11 @@ "name": "listManagementServersMetrics", "params": [ { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "include system level stats", + "description": "", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", @@ -19013,7 +18940,7 @@ "type": "integer" }, { - "description": "the id of the management server", + "description": "The ID of the management server", "length": 255, "name": "id", "related": "listManagementServers", @@ -19021,18 +18948,34 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the version of the management server", "length": 255, - "name": "keyword", + "name": "version", "required": false, + "since": "4.20.3", "type": "string" }, { - "description": "", + "description": "Include system level stats", "length": 255, - "name": "pagesize", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "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": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", @@ -19051,195 +18994,190 @@ "type": "integer" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "The version of the management server", + "name": "version", "type": "string" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the Management Server Peers", - "name": "peers", - "type": "list" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "The last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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": "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 last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" }, { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", + "type": "long" }, { - "description": "the number of client sessions active on this Management Server", + "description": "The number of client sessions active on this Management Server", "name": "sessions", "type": "long" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "The running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", + "description": "The number of threads", + "name": "threadstotalcount", "type": "integer" }, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" + "description": "The state of the management server", + "name": "state", + "type": "state" }, + {}, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "The IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "the number of host agents this Management Server is responsible for", - "name": "agentscount", - "type": "long" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "The log files and their usage on disk", + "name": "loginfo", + "type": "string" }, { - "description": "the agents this Management Server is responsible for", - "name": "agents", - "type": "list" + "description": "The last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "the name of the management server", - "name": "name", + "description": "The ID of the management server", + "name": "id", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "The system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the number of pending jobs in this Management Server", - "name": "pendingjobscount", + "description": "The amount of memory allocated to this Management Server", + "name": "heapmemorytotal", "type": "long" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", + "description": "The time these statistics were collected", + "name": "collectiontime", "type": "date" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, { - "description": "the system has a usage server running locally", + "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": "Total system memory", + "name": "systemmemorytotal", + "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "The last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The amount of memory used by this Management Server", + "name": "heapmemoryused", + "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 this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the number of processors available to the JVM", + "description": "The number of processors available to the JVM", "name": "availableprocessors", "type": "integer" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" - }, - { - "description": "the version of the management server", - "name": "version", - "type": "string" + "description": "The number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "The current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" - }, - { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "The total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "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", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { @@ -19248,25 +19186,30 @@ "type": "string" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "The load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, + { + "description": "The number of daemon threads", + "name": "threadsdaemoncount", "type": "integer" }, { - "description": "the IP Address for this Management Server", - "name": "ipaddress", + "description": "The name of the management server", + "name": "name", "type": "string" }, { - "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", - "name": "lastagents", - "type": "list" + "description": "the IP Address for this Management Server", + "name": "ipaddress", + "type": "string" } ], "since": "4.17.0" }, { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", + "description": "Removes an Instance or a list of Instances from a load balancer rule.", "isasync": true, "name": "removeFromLoadBalancerRule", "params": [ @@ -19274,64 +19217,57 @@ "description": "The ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "The list of IDs of the Instances that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, - "name": "vmidipmap", + "name": "virtualmachineids", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", - "type": "map" + "type": "list" }, { - "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "vmidipmap", "required": false, - "type": "list" + "since": "4.4", + "type": "map" } ], "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": "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", + "description": "The current status of the latest async job acting 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 vm groups", + "description": "Lists Instance groups", "isasync": false, "name": "listInstanceGroups", "params": [ - { - "description": "list instance groups 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. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, @@ -19342,19 +19278,20 @@ { "description": "", "length": 255, - "name": "page", + "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.", + "description": "List Instance groups by ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", @@ -19362,39 +19299,45 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list instance groups by ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, + { + "description": "List Instance groups by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -19402,67 +19345,67 @@ "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the ID of the instance group", - "name": "id", + "description": "The project name of the Instance group", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the account owning the instance group", - "name": "account", + "description": "The domain ID of the Instance group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "The name of the Instance group", + "name": "name", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 domain ID of the instance group", - "name": "domainid", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "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": "path of the Domain the instance group belongs to", "name": "domainpath", "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", + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" - }, - {} + } ] }, { @@ -19471,18 +19414,11 @@ "name": "createStaticRoute", "params": [ { - "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", + "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "nexthop", "required": false, - "type": "uuid" - }, - { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, + "since": "4.21.0", "type": "string" }, { @@ -19495,153 +19431,160 @@ "type": "uuid" }, { - "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", + "description": "The gateway ID we are creating static route for. Mutually exclusive with the nexthop parameter", "length": 255, - "name": "nexthop", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, - "since": "4.21.0", + "type": "uuid" + }, + { + "description": "Static route CIDR", + "length": 255, + "name": "cidr", + "required": true, "type": "string" } ], "related": "listStaticRoutes", "response": [ { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "IP of VPC gateway the route is created for", - "name": "vpcgatewayip", - "type": "string" - }, - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, - {}, - { - "description": "Next hop of the static route", - "name": "nexthop", - "type": "string" - }, - { - "description": "VPC gateway the route is created for", - "name": "vpcgatewayid", - "type": "string" - }, - { - "description": "the ID of static route", - "name": "id", - "type": "string" - }, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "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": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the list of resource tags associated with static route", + "description": "The list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 project name where tag belongs to", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, + { + "description": "The domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", + "type": "string" + }, + { + "description": "The project ID of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name of the static route", + "name": "project", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "The Account associated with the static route", + "name": "account", + "type": "string" + }, { "description": "the domain path associated with the static route", "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Next hop of the static route", + "name": "nexthop", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Static route CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", + "type": "string" + }, + { + "description": "The ID of static route", + "name": "id", + "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 state of the static route", + "name": "state", "type": "string" } ] @@ -19652,7 +19595,7 @@ "name": "deletePrivateGateway", "params": [ { - "description": "the ID of the private gateway", + "description": "The ID of the private gateway", "length": 255, "name": "id", "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", @@ -19661,27 +19604,27 @@ } ], "response": [ - {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -19706,7 +19649,7 @@ "type": "uuid" }, { - "description": "updates domain with this name", + "description": "Updates domain with this name", "length": 255, "name": "name", "required": false, @@ -19716,63 +19659,78 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "The total number of Instances deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "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 gpus the domain can own", + "name": "gpulimit", "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The total number of Instances 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 volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", - "type": "string" + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", - "type": "string" + "description": "The total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "The total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "The total number of CPU cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { @@ -19781,286 +19739,271 @@ "type": "list" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "The total number of public IP addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "The total number of VPCs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "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 Networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", + "description": "The total number of projects available for administration by this domain", "name": "projectavailable", "type": "string" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", - "type": "string" + "description": "The total number of VPCs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "description": "The total number of public IP addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "The total number of Snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "The total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "The total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "Whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, - {}, { - "description": "the 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", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "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 domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", + "description": "The total number of Networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "The total number of CPU cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "The total number of CPU cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "The total number of public IP addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "The total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "The total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the level of the domain", + "description": "The level of the domain", "name": "level", "type": "integer" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", - "type": "string" + "description": "The total number of Templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "Details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "The total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "The total number of Snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "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 deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "The total number of Templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date when this domain was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "The total number of Networks the domain can own", + "name": "networklimit", "type": "string" }, + {}, { - "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", + "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "The path of the domain", + "name": "path", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "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 total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, - { - "description": "the state of the domain", - "name": "state", + "description": "The total number of Instances that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "The total number of VPCs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "The state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "The total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "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", + "description": "The total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" + }, + { + "description": "The total number of Snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" } ] }, { - "description": "Disables an AutoScale Vm Group", + "description": "Disables an AutoScale Instance Group", "isasync": true, "name": "disableAutoScaleVmGroup", "params": [ { - "description": "the ID of the autoscale group", + "description": "The ID of the autoscale group", "length": 255, "name": "id", "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", @@ -20071,179 +20014,163 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The current state of the AutoScale Instance Group", + "name": "state", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "The date when this Instance group was created", + "name": "created", + "type": "date" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "The autoscale profile that contains information about the Instances in the Instance group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "The project name of the Instance group", + "name": "project", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "The name of the guest Network the LB rule belongs to", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "The id of the guest Network the LB rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "The public IP address ID", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The name of the autoscale Instance group ", + "name": "name", + "type": "string" }, + {}, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "The public port", + "name": "publicport", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the project id of the vm group", + "description": "The project id of the Instance group", "name": "projectid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "the autoscale vm group ID", - "name": "id", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, - {}, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "Is group for display to the regular User", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "The frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "The autoscale Instance group ID", + "name": "id", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "List of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the public port", - "name": "publicport", + "description": "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "The domain ID of the Instance group", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the lb provider of the guest network the lb rule belongs to", + "description": "The LB provider of the guest Network the LB rule belongs to", "name": "lbprovider", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "The Load balancer rule ID", + "name": "lbruleid", "type": "string" } ] }, { - "description": "Creates a snapshot policy for the account.", + "description": "Creates a Snapshot policy for the account.", "isasync": false, "name": "createSnapshotPolicy", "params": [ { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "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" }, @@ -20257,9 +20184,9 @@ "type": "list" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "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": "intervaltype", + "name": "schedule", "required": true, "type": "string" }, @@ -20280,11 +20207,20 @@ "type": "list" }, { - "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": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "An optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "Map of tags (key/value pairs)", @@ -20294,7 +20230,14 @@ "type": "map" }, { - "description": "maximum number of snapshots to retain", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": true, + "type": "string" + }, + { + "description": "Maximum number of Snapshots to retain", "length": 255, "name": "maxsnaps", "required": true, @@ -20304,98 +20247,86 @@ "related": "updateSnapshotPolicy,listSnapshotPolicies", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the disk volume", + "description": "The ID of the disk volume", "name": "volumeid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "Maximum number of Snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "Tag value", + "name": "value", "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - {}, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "The time zone of the Snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "The list of pools in which snapshot backup is scheduled", - "name": "storage", - "type": "set" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the disk volume", @@ -20403,34 +20334,46 @@ "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "Is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "time the snapshot is scheduled to be taken.", + "description": "Time the Snapshot is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "The interval type of the Snapshot policy", + "name": "intervaltype", + "type": "short" + }, + {}, + { + "description": "The ID of the Snapshot policy", + "name": "id", + "type": "string" } ] }, @@ -20450,25 +20393,25 @@ ], "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": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "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" } ], @@ -20483,51 +20426,42 @@ "description": "The ID of the volume to unmanage", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "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", + "description": "The 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": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, {} ], "since": "4.19.1" }, { - "description": "List system virtual machines.", + "description": "List System VMs.", "isasync": false, "name": "listSystemVms", "params": [ - { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "3.0.1", - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -20536,34 +20470,35 @@ "type": "string" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "The storage ID where Instance's volumes belong to", "length": 255, - "name": "systemvmtype", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "since": "3.0.1", + "type": "uuid" }, { - "description": "the Pod ID of the system VM", + "description": "The ID of the system VM", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, { - "description": "the name of the system VM", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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": "CPU arch of the system VM", @@ -20574,39 +20509,47 @@ "type": "string" }, { - "description": "", + "description": "The state of the system VM", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the state of the system VM", + "description": "The system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "state", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "", + "description": "The host ID of the system VM", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the host ID of the system VM", + "description": "The Pod ID of the system VM", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "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": "string" + }, + { + "description": "The Zone ID of the system VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } @@ -20614,210 +20557,210 @@ "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the system VM type", - "name": "systemvmtype", + "description": "The systemvm agent version", + "name": "version", "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 template name for the system VM", - "name": "templatename", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The date and time the System VM was created", + "name": "created", + "type": "date" + }, + { + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Zone ID for the System VM", + "name": "zoneid", + "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 Pod ID for the system VM", - "name": "podid", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "The first DNS for the System VM", + "name": "dns1", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The second DNS for the System VM", + "name": "dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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 state of the System VM", + "name": "state", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "The link local MAC address for the System VM", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "The number of active console sessions for the console proxy System VM", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "The Template ID for the System VM", + "name": "templateid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The ID of the System VM", + "name": "id", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "The public IP address for the System VM", + "name": "publicip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "Guest VLAN range", + "name": "guestvlan", "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 public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The Template name for the System VM", + "name": "templatename", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "The gateway for the System VM", + "name": "gateway", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", + "description": "The link local netmask for the System VM", "name": "linklocalnetmask", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The Pod name for the System VM", + "name": "podname", "type": "string" }, { - "description": "the private IP address for the system VM", + "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 ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "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 host ID for the system VM", - "name": "hostid", + "description": "The name of the System VM", + "name": "name", "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 network domain for the system VM", - "name": "networkdomain", + "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 template ID for the system VM", - "name": "templateid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" } ] @@ -20828,16 +20771,16 @@ "name": "createRolePermission", "params": [ { - "description": "The API name or wildcard rule such as list*", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "rule", + "name": "permission", "required": true, "type": "string" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "permission", + "name": "rule", "required": true, "type": "string" }, @@ -20860,504 +20803,504 @@ "related": "listRolePermissions", "response": [ { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", + "description": "The permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the role permission", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the description of the role permission", + "description": "The description of the role permission", "name": "description", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "The name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, - {}, { - "description": "the ID of the 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" } ], "since": "4.9.0" }, { - "description": "Detaches a disk volume from a virtual machine.", + "description": "Detaches a disk volume from an Instance.", "isasync": true, "name": "detachVolume", "params": [ { - "description": "the ID of the disk volume", + "description": "The device ID on the Instance where volume is detached from", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "deviceid", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the device ID on the virtual machine where volume is detached from", + "description": "The ID of the Instance where the volume is detached from", "length": 255, - "name": "deviceid", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the virtual machine where the volume is detached from", + "description": " The ID of the disk volume", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, + {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "Need quiesce Instance 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", + "description": "The bytes allocated", + "name": "virtualsize", "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": "the read (IO) of disk on the vm", + "description": "The read (IO) of disk on the Instance", "name": "diskioread", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "The date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the Instance", + "name": "virtualmachineid", "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "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": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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 write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "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": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", + "description": "An optional field whether to the display the volume to the end User or not.", "name": "displayvolume", "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "name of the primary storage hosting the disk volume", + "description": "Name of the primary storage hosting the disk volume", "name": "storage", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "name of the service offering for root disk", + "description": "Name of the service offering for root disk", "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "Size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Display name of the Instance", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "Min IOPS of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", + "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": "pod name of the volume", - "name": "podname", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "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": "Pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "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 ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" + }, + { + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" } ] }, @@ -21367,15 +21310,15 @@ "name": "replaceNetworkACLList", "params": [ { - "description": "the ID of the network ACL", + "description": "The ID of the network", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "the ID of the private gateway", + "description": "The ID of the private gateway", "length": 255, "name": "gatewayid", "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", @@ -21383,66 +21326,59 @@ "type": "uuid" }, { - "description": "the ID of the network", + "description": "The ID of the network ACL", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The 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": "list Tungsten-Fabric address group", + "description": "List Tungsten-Fabric address group", "isasync": false, "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "List by keyword", + "description": "The ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "List by keyword", "length": 255, - "name": "addressgroupuuid", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -21456,6 +21392,13 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "The uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": false, + "type": "string" } ], "related": "createTungstenFabricAddressGroup", @@ -21471,36 +21414,36 @@ "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone ID", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric address group ip prefix", + "description": "Tungsten-Fabric address group IP prefix", "name": "ipprefix", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group IP prefix length", + "name": "ipprefixlen", + "type": "int" }, {}, { - "description": "Tungsten-Fabric address group uuid", + "description": "Tungsten-Fabric address group UUID", "name": "uuid", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -21510,7 +21453,7 @@ "name": "enableOutOfBandManagementForZone", "params": [ { - "description": "the ID of the zone", + "description": "The ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -21521,72 +21464,72 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "The operation result", + "name": "status", + "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "The operation result description", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", + "description": "True if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "The out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", + "description": "The out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "The ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The out-of-band management interface address", + "name": "address", "type": "string" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "The 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 driver for the host", + "name": "driver", + "type": "string" }, - {} + {}, + { + "description": "The out-of-band management interface password", + "name": "password", + "type": "string" + } ], "since": "4.9.0" }, @@ -21596,23 +21539,31 @@ "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": "Linked domain", "length": 255, - "name": "listtype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "length": 255, + "name": "listtype", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -21623,14 +21574,6 @@ "required": false, "type": "string" }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "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", "length": 255, @@ -21642,40 +21585,29 @@ ], "related": "searchLdap,importLdapUsers", "response": [ - {}, { "description": "The user's firstname", "name": "firstname", "type": "string" }, + {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The 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", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -21684,93 +21616,110 @@ "name": "domain", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, { "description": "The user's username", "name": "username", "type": "string" - } + }, + {} ], "since": "4.2.0" }, { - "description": "Create VM Schedule", + "description": "Create Instance Schedule", "isasync": false, "name": "createVMSchedule", "params": [ { - "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", + "description": "Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).", "length": 255, "name": "action", "required": true, "type": "string" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "End date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "enabled", + "name": "enddate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "ID of the Instance for which schedule is to be defined", "length": 255, - "name": "schedule", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, "name": "startdate", "required": false, "type": "date" }, { - "description": "Description of the schedule", + "description": "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "description", - "required": false, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "Description of the schedule", "length": 255, - "name": "timezone", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "Enable Instance schedule. Defaults to true", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "timezone", + "required": true, + "type": "string" } ], "related": "updateVMSchedule", "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "Description of Instance schedule", + "name": "description", + "type": "string" + }, + {}, + { + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Date from which the schedule is active", @@ -21778,47 +21727,41 @@ "type": "date" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" - }, - { - "description": "Description of VM schedule", - "name": "description", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, - { - "description": "Action", - "name": "action", - "type": "action" - }, { "description": "Date when the schedule was created", "name": "created", "type": "date" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of Instance schedule", + "name": "id", + "type": "string" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, - {}, { - "description": "the ID of VM schedule", - "name": "id", + "description": "ID of Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Cron formatted Instance schedule", + "name": "schedule", "type": "string" }, - {} + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + } ], "since": "4.19.0" }, @@ -21828,239 +21771,239 @@ "name": "listIpForwardingRules", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "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,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, - "type": "string" + "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": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists all rules applied to the specified Instance.", "length": 255, - "name": "account", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List the rule belonging to this public IP address", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list the rule belonging to this public IP address", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "The Instance 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 public IP address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", "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 starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Instance name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "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 protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, - {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "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 public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project 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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], @@ -22069,18 +22012,16 @@ ] }, { - "description": "Creates an instant snapshot of a volume.", + "description": "Creates an instant Snapshot of a volume.", "isasync": true, "name": "createSnapshot", "params": [ { - "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "description": "The name of the Snapshot", "length": 255, - "name": "storageids", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "name", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", @@ -22092,22 +22033,21 @@ "type": "list" }, { - "description": "the name of the snapshot", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "The ID of the disk volume", + "description": "The Account of the Snapshot. The Account parameter must be used with the domainId parameter.", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" + "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. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "description": "The domain ID of the Snapshot. If used with the Account parameter, specifies a domain for the Account associated with the disk volume. If Account is NOT provided then snapshot will be assigned to the caller Account and domain.", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -22115,14 +22055,15 @@ "type": "uuid" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "The ID of the disk volume", "length": 255, - "name": "locationtype", - "required": false, - "type": "string" + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "Policy ID of the Snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, "name": "policyid", "related": "updateSnapshotPolicy,listSnapshotPolicies", @@ -22130,275 +22071,287 @@ "type": "uuid" }, { - "description": "Map of tags (key/value pairs)", + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, - "name": "tags", + "name": "usestoragereplication", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "quiesce vm if true", + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", "length": 255, - "name": "quiescevm", + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "list" }, { - "description": "asynchronous backup if true", + "description": "Asynchronous backup if true", "length": 255, "name": "asyncbackup", "required": false, "type": "boolean" }, { - "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, - "name": "usestoragereplication", + "name": "locationtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "Quiesce Instance if true", "length": 255, - "name": "account", + "name": "quiescevm", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ { - "description": "name of the disk volume", - "name": "volumename", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "Indicates whether the underlying storage supports reverting the volume to this Snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the snapshot", + "description": "The project id of the Snapshot", "name": "projectid", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Valid types are hourly, daily, weekly, monthy, Template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "The parent ID of the Snapshot", + "name": "parent", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the Snapshot", + "name": "id", + "type": "string" + }, + { + "description": "Display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "The type of the Snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "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": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "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": "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 state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "Valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "Name of the Snapshot", + "name": "name", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "Type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" + "description": "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "The Account associated with the Snapshot", + "name": "account", + "type": "string" }, + {}, + {}, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "Name of the disk volume", + "name": "volumename", "type": "string" }, - {}, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", + "description": "Physical size of backed up Snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "The domain ID of the Snapshot's Account", + "name": "domainid", + "type": "string" + }, + { + "description": "The parent name of the Snapshot", + "name": "parentname", "type": "string" } ] @@ -22409,50 +22362,34 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list storage pools belonging to the specific cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the storage pool", + "description": "The scope of the storage pool", "length": 255, - "name": "id", + "name": "scope", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", + "description": "The name of the storage pool", "length": 255, - "name": "storagecustomstats", + "name": "name", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "The Zone ID for the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "The status of the storage pool", "length": 255, - "name": "pagesize", + "name": "status", "required": false, - "type": "integer" + "type": "string" }, { "description": "the name of the storage access group", @@ -22463,195 +22400,207 @@ "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "The IP address for the storage pool", "length": 255, "name": "ipaddress", "required": false, "type": "string" }, { - "description": "the status of the storage pool", + "description": "List by keyword", "length": 255, - "name": "status", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Zone ID for the storage pool", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the scope of the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "The ID of the storage pool", "length": 255, - "name": "name", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "host ID of the storage pools", + "description": "List storage pools belonging to the specific cluster", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the storage pool path", + "description": "The storage pool path", "length": 255, "name": "path", "required": false, "type": "string" + }, + { + "description": "If true, lists the custom stats of the storage pool", + "length": 255, + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" + }, + { + "description": "The Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the pool's currently allocated disk size", + "description": "The pool'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", + "name": "created", + "type": "date" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "Disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" - }, - { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "The ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "The state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "disk size unallocated in GiB", + "description": "Disk size unallocated in GiB", "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "The Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "The tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "Storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" }, { - "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 Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "Storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "Storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the storage pool details", - "name": "details", + "description": "The storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "The name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the storage pool type", - "name": "type", + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -22660,91 +22609,95 @@ "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", + "description": "The name of the cluster for the storage pool", "name": "clustername", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" + "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 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": "Disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "The storage pool type", + "name": "type", "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "Storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "The storage pool path", + "name": "path", "type": "string" }, - {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Disk size allocated in GiB", + "name": "disksizeallocatedgb", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, + {}, { - "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": "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", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" + }, + { + "description": "The scope of the storage pool", + "name": "scope", + "type": "string" } ], "since": "4.9.3" @@ -22754,13 +22707,6 @@ "isasync": false, "name": "updateBackupRepository", "params": [ - { - "description": "shared storage mount options", - "length": 255, - "name": "mountopts", - "required": false, - "type": "string" - }, { "description": "address of the backup repository", "length": 255, @@ -22775,6 +22721,13 @@ "required": false, "type": "boolean" }, + { + "description": "shared storage mount options", + "length": 255, + "name": "mountopts", + "required": false, + "type": "string" + }, { "description": "ID of the backup repository", "length": 255, @@ -22794,29 +22747,40 @@ "related": "addBackupRepository,listBackupRepositories", "response": [ { - "description": "the name of the backup repository", - "name": "name", + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" + }, + {}, + { + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, + { + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, { "description": "the ID of the backup repository", "name": "id", "type": "string" }, - { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" - }, + {}, { "description": "the address / url of the backup repository", "name": "address", "type": "string" }, - {}, { - "description": "the Zone name of the backup repository", - "name": "zonename", + "description": "backup type", + "name": "type", + "type": "string" + }, + { + "description": "mount options", + "name": "mountopts", "type": "string" }, { @@ -22825,38 +22789,72 @@ "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 backups in this repository can be used to create Instances on all Zones", - "name": "crosszoneinstancecreation", - "type": "boolean" + "description": "the name of the backup repository", + "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", + "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 backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + } + ], + "since": "4.22.0" + }, + { + "description": "Deletes a backup offering", + "isasync": false, + "name": "deleteBackupOffering", + "params": [ + { + "description": "ID of the backup offering", + "length": 255, + "name": "id", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "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 date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "backup type", - "name": "type", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.22.0" + "since": "4.14.0" }, { "description": "Create a new keypair and returns the private key", @@ -22864,15 +22862,7 @@ "name": "createSSHKeyPair", "params": [ { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "an optional project for the ssh key", + "description": "An optional project for the SSH key", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -22880,11 +22870,12 @@ "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Name of the keypair", @@ -22892,126 +22883,92 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "An optional Account for the SSH key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Name of the keypair", - "name": "name", + "description": "The project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "ID of the SSH keypair", + "name": "id", + "type": "string" + }, + { + "description": "The domain id of the keypair owner", + "name": "domainid", "type": "string" }, - {}, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" }, - {}, { - "description": "Private key", - "name": "privatekey", + "description": "The project id of the keypair owner", + "name": "projectid", "type": "string" }, + {}, + {}, { - "description": "the owner of the keypair", - "name": "account", + "description": "The domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "The owner of the keypair", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, { - "description": "Deletes a backup offering", - "isasync": false, - "name": "deleteBackupOffering", - "params": [ - { - "description": "ID of the backup offering", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", - "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.14.0" - }, - { - "description": "list Tungsten-Fabric service group", + "description": "List Tungsten-Fabric service group", "isasync": false, "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -23021,23 +22978,24 @@ "type": "integer" }, { - "description": "", + "description": "The uuid of Tungsten-Fabric service group", "length": 255, - "name": "page", + "name": "servicegroupuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "The ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "List by keyword", "length": 255, - "name": "servicegroupuuid", + "name": "keyword", "required": false, "type": "string" } @@ -23045,51 +23003,51 @@ "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", - "type": "string" - }, - { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, + {}, { "description": "Tungsten-Fabric service group end port", "name": "endport", "type": "int" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { "description": "Tungsten-Fabric service group uuid", "name": "uuid", "type": "string" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" } ] }, @@ -23099,7 +23057,15 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "an optional project of the security group", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "An optional project of the security group", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -23107,23 +23073,23 @@ "type": "uuid" }, { - "description": "type of the icmp message being sent", + "description": "The CIDR list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmptype", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "end port for this egress rule", + "description": "An optional account for the security group. Must be used with domainId.", "length": 255, - "name": "endport", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "start port for this egress rule", + "description": "Type of the ICMP message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, @@ -23135,22 +23101,7 @@ "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -23158,30 +23109,37 @@ "type": "uuid" }, { - "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": "user to security group mapping", + "description": "User to security group mapping", "length": 255, "name": "usersecuritygrouplist", "required": false, "type": "map" }, { - "description": "error code for this icmp message", + "description": "End port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "Error code for this icmp message", "length": 255, "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "an optional 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" } @@ -23189,124 +23147,124 @@ "related": "authorizeSecurityGroupIngress", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "The 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" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The 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 value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "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 starting IP of the security group rule", - "name": "startport", + "description": "The type of the ICMP message response", + "name": "icmptype", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, {}, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + } ], "since": "3.0.0" }, @@ -23316,47 +23274,41 @@ "name": "listStoragePools", "params": [ { - "description": "list storage pools belonging to the specific cluster", + "description": "The ID of the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "the status of the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "status", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "host ID of the storage pools", + "description": "The storage pool path", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage pool path", + "description": "The scope of the storage pool", "length": 255, - "name": "path", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, @@ -23369,41 +23321,41 @@ "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "The Zone ID for the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the name of the storage access group", + "description": "The name of the storage pool", "length": 255, - "name": "storageaccessgroup", + "name": "name", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "the name of the storage pool", + "description": "The IP address for the storage pool", "length": 255, - "name": "name", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "", + "description": "List storage pools belonging to the specific cluster", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -23413,205 +23365,211 @@ "type": "string" }, { - "description": "the scope of the storage pool", + "description": "the name of the storage access group", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "The status of the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "status", "required": false, - "type": "uuid" + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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 nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", + "description": "The pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "The state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "The ID of the storage pool", + "name": "id", "type": "string" }, {}, - {}, { - "description": "the ID of the cluster for the storage pool", + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "The ID of the cluster for the storage pool", "name": "clusterid", "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 storage pool path", - "name": "path", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "The total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "The name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", + "description": "True if this pool is suitable to migrate a volume, false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "The Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "The UUID of the latest async job acting on 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 cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "The date and time the storage pool was created", + "name": "created", + "type": "date" }, + {}, { "description": "whether this pool is managed or not", "name": "managed", "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "The Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "The scope of the storage pool", + "name": "scope", "type": "string" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, { "description": "the storage access groups for the storage pool", "name": "storageaccessgroups", "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the pool's currently allocated disk size", - "name": "disksizeallocated", + "description": "The pool's currently used disk size", + "name": "disksizeused", "type": "long" - }, - { - "description": "the storage pool details", - "name": "details", - "type": "map" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" } ] }, @@ -23621,31 +23579,22 @@ "name": "updateHypervisorCapabilities", "params": [ { - "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": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "The hypervisor for which the hypervisor capabilities are to be updated", "length": 255, - "name": "hypervisorversion", + "name": "hypervisor", "required": false, "since": "4.19.1", "type": "string" }, { - "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "description": "Set true to enable security group for this hypervisor.", "length": 255, - "name": "hypervisor", + "name": "securitygroupenabled", "required": false, - "since": "4.19.1", - "type": "string" + "type": "boolean" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "Set true to enable Instance Snapshots for this hypervisor", "length": 255, "name": "vmsnapshotenabled", "required": false, @@ -23653,23 +23602,30 @@ "type": "boolean" }, { - "description": "ID of the hypervisor capability", + "description": "The maximum number of Guest Instances per host for this hypervisor.", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "maxguestslimit", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "The hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "maxhostspercluster", + "name": "hypervisorversion", + "required": false, + "since": "4.19.1", + "type": "string" + }, + { + "description": "The maximum number of Data Volumes that can be attached to an Instance 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 storage motion support for this hypervisor", "length": 255, "name": "storagemotionenabled", "required": false, @@ -23677,87 +23633,96 @@ "type": "boolean" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "ID of the hypervisor capability", "length": 255, - "name": "maxguestslimit", + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "The maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "securitygroupenabled", + "name": "maxhostspercluster", "required": false, - "type": "boolean" + "since": "4.16.0", + "type": "integer" } ], "related": "listHypervisorCapabilities", "response": [ { - "description": "true if VM snapshots are enabled for this hypervisor", + "description": "True if Instance Snapshots are enabled for this hypervisor", "name": "vmsnapshotenabled", "type": "boolean" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", + "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 hypervisor type", - "name": "hypervisor", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", - "type": "string" - }, - { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "The maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "True if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The hypervisor type", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "The maximum number of guest Instances recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "description": "true if storage motion is supported", + "description": "True if storage motion is supported", "name": "storagemotionenabled", "type": "boolean" }, - {} + { + "description": "The hypervisor capability ID", + "name": "id", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.0" }, { - "description": "Find hosts suitable for migrating a virtual machine.", + "description": "Find hosts suitable for migrating an Instance.", "isasync": false, "name": "findHostsForMigration", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -23766,20 +23731,13 @@ "type": "integer" }, { - "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "description": "Find hosts to which this Instance can be migrated and flag the hosts with enough CPU/RAM to host the Instance", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -23791,125 +23749,225 @@ "related": "", "response": [ { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + {}, + { + "description": "The state of the host", + "name": "state", + "type": "status" + }, + { + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "True if the host 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", + "description": "The CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "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": "The name of extension for this cluster", - "name": "extensionname", + "description": "True if migrating an Instance to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" + }, + { + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "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", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "The management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "The admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "True if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "The ID of the host", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The Zone name of the host", + "name": "zonename", "type": "string" }, - {}, { - "description": "the date and time the host was removed", + "description": "Events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "True if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "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": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "The host type", + "name": "type", + "type": "type" + }, + { + "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": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "The amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "The OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { "description": "GPU cards present in the host", @@ -23921,32 +23979,37 @@ "type": "string" }, { - "description": "the list of enabled vGPUs", + "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", + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", "name": "remainingcapacity", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, { "description": "Model Name of vGPU", "name": "vgputype", "type": "string" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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 no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -23955,13 +24018,8 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], @@ -23971,13 +24029,13 @@ "type": "list" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { @@ -23985,35 +24043,21 @@ "name": "gpuused", "type": "long" }, + {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the cluster name of the host", + "description": "The cluster name of the host", "name": "clustername", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { "description": "Host details in key/value pairs.", @@ -24021,156 +24065,100 @@ "type": "map" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, - { - "description": "comma-separated list of tags for the host", + "description": "Comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", + "description": "The amount of the host's CPU currently allocated", "name": "cpuallocated", "type": "string" }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "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 state of the host", - "name": "state", - "type": "status" - }, { "description": "the management server name of the host", "name": "managementservername", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "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 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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - {}, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The Zone ID of the host", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", @@ -24178,64 +24166,34 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "The CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" } ] }, @@ -24256,75 +24214,75 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" + "description": "Storage VLAN ID of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, {}, { - "description": "device state", + "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "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": "Management VLAN ID of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "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": "device name", + "description": "Device name", "name": "vsmdevicename", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "Control VLAN ID of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain ID", + "name": "vsmdomainid", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "Device ID of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "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", + "description": "Packet VLAN ID of the VSM", + "name": "vsmpktvlanid", "type": "int" } ] @@ -24345,56 +24303,49 @@ ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "is domain admin allowed to create offerings with tags", + "description": "Is domain admin allowed to create offerings with tags", "name": "isallowed", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Adds VM to specified network by creating a NIC", + "description": "Adds Instance to specified network by creating a NIC", "isasync": true, "name": "addNicToVirtualMachine", "params": [ { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptions", - "required": false, - "type": "map" - }, - { - "description": "Mac Address for the new network", + "description": "Mac Address for the new Network", "length": 255, "name": "macaddress", "required": false, "type": "string" }, { - "description": "IP Address for the new network", + "description": "IP Address for the new Network", "length": 255, "name": "ipaddress", "required": false, "type": "string" }, { - "description": "Virtual Machine ID", + "description": "Instance ID", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, @@ -24405,826 +24356,267 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,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", + "length": 255, + "name": "dhcpoptions", + "required": false, + "type": "map" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - {}, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the 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": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "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", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the name of the affinity group", + "description": "The name of the affinity group", "name": "name", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "The ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the description of the affinity group", + "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The list of NICs associated with Instance", + "name": "nic", "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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the 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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", + "description": "The Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", + "description": "The isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The IP address of the NIC", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { @@ -25233,266 +24625,319 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the type of the nic", + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + }, + { + "description": "The type of the NIC", "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", + "description": "True if NIC is default, false otherwise", "name": "macaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the netmask of the nic", + "description": "The netmask of the NIC", "name": "netmask", "type": "string" + } + ], + "type": "set" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The project name of the Instance", + "name": "project", + "type": "string" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", + "description": "An alternate display text of the ISO attached to the Instance", "name": "isodisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Instance name of the user Instance; 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": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { @@ -25501,54 +24946,49 @@ "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { "description": "State of the Service from LB rule", @@ -25556,452 +24996,945 @@ "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": "VNF details", - "name": "vnfdetails", - "type": "map" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" - } - ], - "related": "", - "response": [ + }, { - "description": "the domain path associated with the static route", - "name": "domainpath", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "id of the resource", - "name": "resourceid", - "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": "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 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": "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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", - "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": "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 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account owning the security group", + "name": "account", "type": "string" - } - ], - "type": "list" - }, - { - "description": "VPC gateway the route is created for", - "name": "vpcgatewayid", - "type": "string" - }, - { - "description": "IP of VPC gateway the route is created for", - "name": "vpcgatewayip", + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The 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 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", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "Next hop of the static route", - "name": "nexthop", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, {}, { - "description": "the account associated with the static route", + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" + } + ] + }, + { + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", + "params": [ + { + "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 Instances", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "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 route by ID", + "length": 255, + "name": "id", + "related": "listStaticRoutes", + "required": false, + "type": "uuid" + }, + { + "description": "List static routes by gateway ID", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" + }, + { + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the state of the static route", + "description": "List static routes by state", + "length": 255, "name": "state", + "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the static route", + "description": "List only resources belonging to the domain specified", + "length": 255, "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "The project ID of the static route", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "The Account associated with the static route", + "name": "account", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" + }, + { + "description": "The domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "The ID of static route", + "name": "id", "type": "string" }, { - "description": "static route CIDR", + "description": "Static route CIDR", "name": "cidr", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "The project name of the static route", + "name": "project", "type": "string" }, - {} - ] - }, - { - "description": "Returns SAML2 CloudStack Service Provider MetaData", - "isasync": false, - "name": "getSPMetadata", - "params": [], - "related": "", - "response": [ { - "description": "The Metadata XML", - "name": "metadata", + "description": "The list of resource tags associated with static route", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "list" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { - "description": "Lists all public ip addresses", + "description": "Lists all public IP addresses", "isasync": false, "name": "listPublicIpAddresses", "params": [ { - "description": "lists IP address by ID", + "description": "List only IPs used for load balancing", "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "forloadbalancing", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list only static NAT IP addresses", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isstaticnat", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "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": "lists all public IP addresses by zone ID", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "true if range is dedicated for external network provider", + "description": "Lists the specified IP address", "length": 255, - "name": "forprovider", + "name": "ipaddress", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "string" }, { - "description": "the virtual network for the IP address", + "description": "Lists all public IP addresses by VLAN ID", "length": 255, - "name": "forvirtualnetwork", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists all public IP addresses by source Network ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.13.0", "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "lists all public IP addresses by source network ID", + "description": "Lists IP address by ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.13.0", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "fordisplay", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "List only source NAT IP addresses", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "issourcenat", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "limits search results to allocated public IP addresses", + "description": "The virtual Network for the IP address", "length": 255, - "name": "allocatedonly", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list only source NAT IP addresses", + "description": "List only static NAT IP addresses", "length": 255, - "name": "issourcenat", + "name": "isstaticnat", "required": false, "type": "boolean" }, { - "description": "true if range is dedicated for system VMs", + "description": "true if range is dedicated for external network provider", "length": 255, - "name": "forsystemvms", + "name": "forprovider", "required": false, - "since": "4.20.0", + "since": "4.21.0", "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Lists all public IP addresses associated to the Network specified", "length": 255, - "name": "listall", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List IPs belonging to the VPC", + "description": "Lists all public IP addresses by state. A comma-separated list of states can be passed.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -26011,301 +25944,305 @@ "type": "string" }, { - "description": "lists the specified IP address", + "description": "Lists all public IP addresses by physical Network ID", "length": 255, - "name": "ipaddress", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "account", + "name": "forsystemvms", "required": false, - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { - "description": "lists all public IP addresses by state", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Limits search results to allocated public IP addresses", "length": 255, - "name": "tags", + "name": "allocatedonly", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list only IPs used for load balancing", + "description": "Lists all public IP addresses by zone ID", "length": 255, - "name": "forloadbalancing", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the project name of the address", - "name": "project", + "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", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "The domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "The name of the Network where IP belongs to", + "name": "networkname", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, { - "description": "true if the IP address is a source nat address, false otherwise", + "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", + "description": "Instance name the IP address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "VPC id the ip belongs to", + "description": "VPC ID the IP belongs to", "name": "vpcid", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "The Account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "Is public IP for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "Public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "Instance type the IP address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "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": "Is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "The VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, {}, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Instance (DNAT) IP address (not null only for static NAT IP)", + "name": "vmipaddress", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "Instance display name the IP address is assigned to (not null only for static NAT IP)", + "name": "virtualmachinedisplayname", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "public IP address", - "name": "ipaddress", + "description": "The name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "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 (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP address ID", + "name": "id", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "Instance id the IP address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "The domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "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": "VPC name the IP belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" + "description": "Date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the list of resource tags associated with ip address", + "description": "The list of resource tags associated with IP address", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the 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": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", + "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 id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "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": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "The ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" - }, - { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" } ] }, @@ -26315,7 +26252,7 @@ "name": "listOpenDaylightControllers", "params": [ { - "description": "the ID of a OpenDaylight Controller", + "description": "The ID of a OpenDaylight Controller", "length": 255, "name": "id", "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", @@ -26323,7 +26260,7 @@ "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", @@ -26335,38 +26272,38 @@ "response": [ {}, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The physical Network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name assigned to the controller", + "description": "The name assigned to the controller", "name": "name", "type": "string" }, { - "description": "the username to authenticate to the controller", + "description": "The username to authenticate to the controller", "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the url of the controller api", + "description": "The URL of the controller API", "name": "url", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Device ID of the controller", + "name": "id", "type": "string" }, {} @@ -26378,142 +26315,142 @@ "name": "addBigSwitchBcfDevice", "params": [ { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "The Physical Network ID", "length": 255, - "name": "nat", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "boolean" + "type": "uuid" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Password of the BigSwitch BCF Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Password of the BigSwitch BCF Controller.", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "password", + "name": "hostname", "required": true, "type": "string" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, - "name": "username", + "name": "nat", "required": true, - "type": "string" + "type": "boolean" } ], "related": "listBigSwitchBcfDevices", "response": [ { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The controller password", + "name": "password", + "type": "string" }, {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "The physical Network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "Device ID of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "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 controller password", - "name": "password", + "description": "The controller username", + "name": "username", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "The controller IP address", + "name": "hostname", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "4.6.0" }, { - "description": "Changes the default NIC on a VM", + "description": "Changes the default NIC on an Instance", "isasync": true, "name": "updateDefaultNicForVirtualMachine", "params": [ { - "description": "NIC ID", + "description": "Instance ID", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "NIC ID", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" }, { "description": "VNF details", @@ -26521,1134 +26458,1139 @@ "type": "map" }, { - "description": "the VM's disk read in KiB", - "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": "User VM type", - "name": "vmtype", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "device ID of the root volume", + "description": "Device ID of the root volume", "name": "rootdeviceid", "type": "long" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "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 Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The internal memory (KiB) that's free in Instance 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 ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "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": "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 account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The group name of the Instance", + "name": "group", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "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 name of the security group", + "name": "name", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "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 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "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 name of the corresponding network", - "name": "networkname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "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 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 list of resource tags associated with the rule", + "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 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": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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": "Tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", + "description": "The ID of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", + "description": "Security group name", "name": "securitygroupname", "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "The project name of the group", + "name": "project", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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 type of the ICMP message response", - "name": "icmptype", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "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", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "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", + "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": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "Account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", "type": "set" + }, + { + "description": "The domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", + "description": "The Instance's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "The amount of the Instance'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 Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the maximum X resolution", "name": "maxresolutionx", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", "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 Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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 Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "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": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "Tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The project name of the Instance", + "name": "project", + "type": "string" }, { - "description": "Vm details in key/value pairs.", + "description": "Instance details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "The incoming Network traffic on the Instance 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 userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" } ] @@ -27676,190 +27618,51 @@ ], "related": "executeClusterDrsPlan", "response": [ + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, { "description": "Id of the cluster", "name": "clusterid", "type": "string" }, {}, - {}, - {}, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" - }, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Type of DRS Plan (Automated or Manual))", "name": "type", "type": "type" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "List of migrations", "name": "migrations", "type": "list" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", - "params": [ - { - "description": "id of the user to be deleted", - "length": 255, + "description": "unique ID of the drs plan for cluster", "name": "id", - "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": "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": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ - { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - }, - { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", - "response": [ - {}, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management interface 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 driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" } ], - "since": "4.9.0" + "since": "4.19.0" }, { "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", @@ -27867,20 +27670,12 @@ "name": "createSharedFileSystem", "params": [ { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", + "description": "the name of the shared filesystem.", "length": 255, - "name": "filesystem", + "name": "name", "required": true, "type": "string" }, - { - "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, @@ -27890,9 +27685,9 @@ "type": "uuid" }, { - "description": "max iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, @@ -27905,10 +27700,17 @@ "type": "uuid" }, { - "description": "the name of the shared filesystem.", + "description": "the description for the shared filesystem.", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { @@ -27920,41 +27722,41 @@ "type": "uuid" }, { - "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", + "description": "min iops", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the size of the shared filesystem in GiB", + "description": "max iops", "length": 255, - "name": "size", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "the zone id.", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "filesystem", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "min iops", + "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "the description for the shared filesystem.", + "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", "length": 255, - "name": "description", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", @@ -27964,257 +27766,253 @@ "type": "string" }, { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "description": "the zone id.", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, { "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the bytes actually consumed on disk", "name": "physicalsize", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, + {}, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "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": "tag key name", - "name": "key", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", + "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" } ], "type": "set" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, - {}, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the shared filesystem'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": "ID of the shared filesystem", - "name": "id", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { @@ -28222,172 +28020,187 @@ "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The type of the NIC", + "name": "type", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the isolated private VLAN if available", + "description": "The isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The gateway of the NIC", + "name": "gateway", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", + "description": "Public IP address ID associated with this NIC via Static NAT rule", "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "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 netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" } ], "type": "list" }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, { "description": "Network name of the shared filesystem", "name": "networkname", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "ID of the storage fs vm", @@ -28395,22 +28208,151 @@ "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", + "params": [ + { + "description": "ID of the user to be deleted", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "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": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ + { + "description": "Out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "Optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "The ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "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": "name of the storage fs data volume", - "name": "volumename", + "description": "The out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "The out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "The out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "The operation result", + "name": "status", + "type": "boolean" + }, + { + "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": "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 out-of-band management interface username", + "name": "username", "type": "string" } ], - "since": "4.20.0" + "since": "4.9.0" }, { "description": "Deletes network device.", @@ -28428,24 +28370,24 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -28457,11 +28399,11 @@ "name": "updateImageStore", "params": [ { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "The new name for the Image Store.", "length": 255, - "name": "readonly", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", @@ -28479,100 +28421,100 @@ "type": "uuid" }, { - "description": "The new name for the Image Store.", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "name", + "name": "readonly", "required": false, - "type": "string" + "type": "boolean" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "The name of the image store", + "name": "name", "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 Zone ID of the image store", + "description": "The Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "The Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "The protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "The host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "The ID of the image store", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, + {}, { - "description": "the url of the image store", - "name": "url", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The URL of the image store", + "name": "url", + "type": "string" }, { - "description": "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" }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "description": "Assigns an Instance or a list of Instances to a load balancer rule.", "isasync": true, "name": "assignToLoadBalancerRule", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -28585,34 +28527,34 @@ "type": "map" }, { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "description": "The list of IDs of the Instance that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "list" } ], "response": [ + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -28632,74 +28574,74 @@ "type": "uuid" }, { - "description": "UUID of the cluster", + "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "storageaccessgroups", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "list" }, { - "description": "UUID of the zone", + "description": "UUID of the pod", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "UUID of the pod", + "description": "UUID of the Storage Pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", + "description": "UUID of the zone", "length": 255, - "name": "storageaccessgroups", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.21.0", - "type": "list" + "type": "uuid" }, { - "description": "UUID of the Storage Pool", + "description": "UUID of the cluster", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.21.0" }, { - "description": "Lists all pending asynchronous jobs for the account.", + "description": "Lists all pending asynchronous jobs for the Account.", "isasync": false, "name": "listAsyncJobs", "params": [ @@ -28711,18 +28653,19 @@ "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "", + "description": "the type of the resource associated with the job", "length": 255, - "name": "page", + "name": "resourcetype", "required": false, - "type": "integer" + "since": "4.22.1", + "type": "string" }, { "description": "The id of the management server", @@ -28734,18 +28677,26 @@ "type": "uuid" }, { - "description": "", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the resource associated with the job", "length": 255, - "name": "isrecursive", + "name": "resourceid", "required": false, - "type": "boolean" + "since": "4.22.1", + "type": "string" + }, + { + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -28755,7 +28706,7 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -28763,107 +28714,114 @@ "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "queryAsyncJobResult", "response": [ { - "description": "the account that executed the async command", - "name": "account", + "description": "The MSID of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "The result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "The result reason", + "name": "jobresult", + "type": "responseobject" }, + {}, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "The Account ID that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "The domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "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 management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "The created date of the job", + "name": "created", + "type": "date" + }, + { + "description": "The Account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "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 User that executed the async command", + "name": "userid", "type": "string" }, + {}, { - "description": "the async command executed", - "name": "cmd", + "description": "The domain ID that executed the async command", + "name": "domainid", "type": "string" }, { - "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", + "description": "The result code for the job", "name": "jobresultcode", "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "The Instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "description": "The async command executed", + "name": "cmd", "type": "string" - }, - {} + } ] }, { @@ -28872,57 +28830,57 @@ "name": "archiveAlerts", "params": [ { - "description": "archive by alert type", + "description": "The IDs of the alerts", + "length": 255, + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "type": "list" + }, + { + "description": "Archive by alert type", "length": 255, "name": "type", "required": false, "type": "string" }, { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "End date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, "name": "enddate", "required": false, "type": "date" }, { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "Start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, "name": "startdate", "required": false, "type": "date" - }, - { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", - "required": false, - "type": "list" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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" }, + {}, {} ] }, @@ -28943,26 +28901,26 @@ "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -28971,9 +28929,17 @@ "name": "createSecondaryStorageSelector", "params": [ { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", + "description": "The zone in which the heuristic rule will be applied.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The name identifying the heuristic rule.", + "length": 255, + "name": "name", "required": true, "type": "string" }, @@ -28985,9 +28951,9 @@ "type": "string" }, { - "description": "The name identifying the heuristic rule.", - "length": 255, - "name": "name", + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", "required": true, "type": "string" }, @@ -28997,32 +28963,25 @@ "name": "description", "required": true, "type": "string" - }, - { - "description": "The zone in which the heuristic rule will be applied.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" } ], "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ + {}, { - "description": "Description of the heuristic.", - "name": "description", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, { "description": "ID of the heuristic.", @@ -29030,36 +28989,35 @@ "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, {}, { "description": "When the heuristic was removed.", "name": "removed", "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" } ], "since": "4.19.0" @@ -29077,21 +29035,21 @@ "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "Hostname of IP address of the Brocade VCS Switch.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", @@ -29101,42 +29059,42 @@ ], "related": "listBrocadeVcsDevices", "response": [ - { - "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": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", + "description": "The physical Network to which this Brocade VCS belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "The principal switch IP address", + "name": "hostname", "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "Device ID of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "Device name", + "name": "brocadedevicename", + "type": "string" } ] }, @@ -29145,13 +29103,6 @@ "isasync": true, "name": "deleteTags", "params": [ - { - "description": "Delete tags for resource id(s)", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, { "description": "Delete tags matching key/value pairs", "length": 255, @@ -29165,101 +29116,109 @@ "name": "resourcetype", "required": true, "type": "string" + }, + { + "description": "Delete tags for resource id(s)", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ], "since": "4.0.0" }, { - "description": "create Tungsten-Fabric tag type", + "description": "Create Tungsten-Fabric tag type", "isasync": true, "name": "createTungstenFabricTagType", "params": [ { - "description": "Tungsten-Fabric tag type name", + "description": "The ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric tag type name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listTungstenFabricTagType", "response": [ + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "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", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "cleanup", + "name": "makeredundant", "required": false, + "since": "4.11.1", "type": "boolean" }, { @@ -29279,37 +29238,36 @@ "type": "uuid" }, { - "description": "Turn the network into a network with redundant routers.", + "description": "If cleanup old network elements", "length": 255, - "name": "makeredundant", + "name": "cleanup", "required": false, - "since": "4.11.1", "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": "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", + "description": "The 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" - } + {}, + {} ] }, { @@ -29318,10 +29276,10 @@ "name": "login", "params": [ { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Username", "length": 255, - "name": "domain", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -29339,49 +29297,48 @@ "type": "long" }, { - "description": "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": "username", - "required": true, + "name": "domain", + "required": false, "type": "string" } ], - "related": "samlSso,oauthlogin", + "related": "oauthlogin", "response": [ { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", - "type": "string" + "description": "The time period before the session has expired", + "name": "timeout", + "type": "integer" }, - {}, { "description": "Is two factor authentication verified", "name": "is2faverified", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "First name of the user", + "name": "firstname", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Username", - "name": "username", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { @@ -29390,61 +29347,62 @@ "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Last name of the user", + "name": "lastname", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "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": "User time zoneoffset", + "name": "timezoneoffset", + "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "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": "User ID", + "name": "userid", "type": "string" }, { - "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" }, { - "description": "User ID", - "name": "userid", + "description": "Is user registered", + "name": "registered", "type": "string" }, - {}, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "Username", + "name": "username", "type": "string" }, + {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "The Account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "The Account name the User belongs to", + "name": "account", "type": "string" - } + }, + {} ] }, { @@ -29453,32 +29411,32 @@ "name": "listHypervisorCapabilities", "params": [ { - "description": "List by keyword", + "description": "The hypervisor for which to restrict the search", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "", "length": 255, - "name": "hypervisor", + "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": "ID of the hypervisor capability", @@ -29492,62 +29450,62 @@ "related": "", "response": [ { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "The hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "The hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "True if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "The hypervisor capability ID", + "name": "id", "type": "string" }, + {}, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "True if Instance Snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "The maximum number of guest Instances 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", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, - {} + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -29574,25 +29532,25 @@ } ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -29616,8 +29574,8 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "variable", + "name": "variable", "type": "string" }, { @@ -29627,14 +29585,14 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "variable", - "name": "variable", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20" @@ -29645,14 +29603,14 @@ "name": "quotaBalance", "params": [ { - "description": "Account Id for which statement needs to be generated", + "description": "Start of the period of the Quota balance. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "account", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "List usage records for the specified account", + "description": "List usage records for the specified Account", "length": 255, "name": "accountid", "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", @@ -29666,6 +29624,13 @@ "required": false, "type": "date" }, + { + "description": "Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": true, + "type": "string" + }, { "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, @@ -29673,63 +29638,56 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" - }, - { - "description": "Start of the period of the Quota balance. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" } ], "related": "quotaStatement", "response": [ - {}, { - "description": "account name", - "name": "account", + "description": "Usage type name", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Account name", + "name": "account", "type": "string" }, { - "description": "usage type", - "name": "type", - "type": "int" - }, - { - "description": "account id", - "name": "accountid", - "type": "long" + "description": "Quota consumed", + "name": "quota", + "type": "bigdecimal" }, { - "description": "usage unit", - "name": "unit", - "type": "string" + "description": "Usage type", + "name": "type", + "type": "int" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "Account id", + "name": "accountid", + "type": "long" }, { - "description": "usage type name", - "name": "name", + "description": "Domain id", + "name": "domain", + "type": "long" + }, + { + "description": "Usage unit", + "name": "unit", "type": "string" }, { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.7.0" @@ -29740,16 +29698,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" } @@ -29757,19 +29715,19 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" }, {}, {}, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -29792,45 +29750,45 @@ "related": "", "response": [ { - "description": "the name of the role to which the role permission belongs", + "description": "The name of the role to which the role permission belongs", "name": "rolename", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" }, + {}, { - "description": "the description of the role permission", - "name": "description", + "description": "The 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 ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "The description of the role permission", + "name": "description", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the role permission", + "name": "id", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "The api name or wildcard rule", + "name": "rule", "type": "string" } ], @@ -29842,144 +29800,144 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "List by keyword", + "description": "List dedicated guest VLAN ranges by ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the dedicated guest vlan range", + "description": "Project who will own the guest VLAN range", "length": 255, - "name": "guestvlanrange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "physical network id of the guest VLAN range", + "description": "The domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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": "The account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "project who will own the guest VLAN range", + "description": "The dedicated guest vlan range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "Physical network ID of the guest VLAN range", "length": 255, - "name": "id", - "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "Zone of the guest VLAN range", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "dedicateGuestVlanRange", "response": [ { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "The physical Network of the guest VLAN range", + "name": "physicalnetworkid", + "type": "long" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the guest vlan range", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The project name of the guest VLAN range", "name": "project", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "The Account of the guest VLAN range", + "name": "account", "type": "string" }, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "The 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", + "type": "string" }, { - "description": "the guest VLAN range", + "description": "The guest VLAN range", "name": "guestvlanrange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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", + "description": "The domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, + {}, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "The domain name of the guest VLAN range", + "name": "domain", "type": "string" - }, - { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" } ] }, @@ -29989,100 +29947,100 @@ "name": "listNetworkACLs", "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": "Lists network ACL Item with the specified ID", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 by keyword", + "description": "List network ACL items by ACL ID", "length": 255, - "name": "keyword", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "List network ACL items by network ID", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List network ACL items by traffic type - ingress or egress", "length": 255, - "name": "pagesize", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list network ACL items by protocol", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "protocol", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "list network ACL items by action", + "description": "List by keyword", "length": 255, - "name": "action", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list network ACL items by network ID", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List network ACL items by action", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "action", "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 Instances", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list network ACL items by ACL ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list resources by 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,moveDomain", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -30092,573 +30050,573 @@ "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "listall", + "name": "id", + "related": "createNetworkACL,importNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List network ACL items by protocol", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "related": "createNetworkACL,importNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "The state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "The traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "The ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "An explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "The protocol of the ACL", + "name": "protocol", "type": "string" }, + { + "description": "Error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "Action of ACL Item. Allow/Deny", "name": "action", "type": "string" }, + { + "description": "The ending port of ACL's port range", + "name": "endport", + "type": "string" + }, {}, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "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": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "The starting port of ACL's port range", + "name": "startport", + "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": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the Network ACLs", "name": "tags", "response": [ { - "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": "Resource type", + "name": "resourcetype", "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": "the project id the tag belongs to", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {}, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" } ] }, { - "description": "Copies a template from one zone to another.", + "description": "Copies a Template from one zone to another.", "isasync": true, "name": "copyTemplate", "params": [ { - "description": "ID of the zone the template is being copied to.", + "description": "Template ID.", "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "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": "uuid" + "type": "list" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "ID of the zone the Template is 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": "destzoneids", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Template ID.", + "description": "ID of the zone the Template is being copied to.", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the status of the template", - "name": "status", + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "Lists the download progress of a Template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The date this Template was created", + "name": "created", + "type": "date" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "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 userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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 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 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 project name of the Template", + "name": "project", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "The processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the size of the template", + "description": "The size of the Template", "name": "size", "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "The name of the zone for this Template", + "name": "zonename", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "The date this Template was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The tag of this Template", + "name": "templatetag", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "the physical size of the template", + "description": "The physical size of the Template", "name": "physicalsize", "type": "long" }, { - "description": "CPU Arch of the template", - "name": "arch", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "the template display text", + "description": "The Template display text", "name": "displaytext", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "The Account id to which the Template belongs", + "name": "accountid", "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 the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "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", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The type of the Template", + "name": "templatetype", "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" + }, + { + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" } ] }, { - "description": "lists network that are using a nicira nvp device", + "description": "Lists network that are using a nicira nvp device", "isasync": false, "name": "listNiciraNvpDeviceNetworks", "params": [ @@ -30669,6 +30627,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -30683,188 +30648,247 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "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 type of the network", - "name": "type", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The first IPv4 DNS for the Network", + "name": "dns1", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, + {}, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "ACL type - access type to the Network", + "name": "acltype", "type": "string" }, { - "description": "the list of resource tags associated with network", + "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": "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": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", + "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": "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", "type": "string" } ], "type": "list" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The date this Network was created", + "name": "created", + "type": "date" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", "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 IPv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "True if Network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "Related to what other Network configuration", + "name": "related", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "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": "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 provider name", + "name": "name", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The list of capabilities", + "name": "capability", + "response": [ + { + "description": "The capability name", + "name": "name", + "type": "string" + }, + { + "description": "The capability value", + "name": "value", + "type": "string" + }, + { + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "An optional field, whether to the display the Network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The ID of the Network", + "name": "id", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "description": "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", "name": "reservediprange", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, { @@ -30873,351 +30897,285 @@ "type": "set" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The second IPv4 DNS for the Network", + "name": "dns2", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "State of the Network", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "True if Network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "The details of the Network", + "name": "details", + "type": "map" }, { - "description": "name of the network offering the network is created from", + "description": "Name of the Network offering the Network is created from", "name": "networkofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "True if Network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, + { + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + {}, { "description": "MTU configured on the network VR's private interfaces", "name": "privatemtu", "type": "integer" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "True if Network supports specifying IP ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the 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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The name of the zone the Network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The domain ID of the Network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "List Networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "ACL name associated with the VPC network", + "description": "ACL name associated with the VPC Network", "name": "aclname", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the owner of the network", - "name": "account", + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The Network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "Path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the cidr of IPv6 network", + "description": "The CIDR of IPv6 Network", "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "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": "Network offering ID the Network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "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 first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "True if guest Network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The type of the Network", + "name": "type", "type": "string" }, - {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The internet protocol of Network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The displaytext of the Network", + "name": "displaytext", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC the Network belongs to", + "name": "vpcid", "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 Instance deployment", + "name": "canusefordeploy", "type": "boolean" + }, + { + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" } ] }, @@ -31236,28 +31194,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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.6.0" }, @@ -31267,29 +31225,28 @@ "name": "listOvsElements", "params": [ { - "description": "list network offerings by enabled state", + "description": "List network offerings by enabled state", "length": 255, "name": "enabled", "required": false, "type": "boolean" }, { - "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 ovs elements by network service provider id", + "description": "List ovs elements by network service provider id", "length": 255, "name": "nspid", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", @@ -31297,195 +31254,164 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List ovs elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "configureOvsElement", "response": [ + {}, { - "description": "the account associated with the provider", + "description": "The Account associated with the provider", "name": "account", "type": "string" }, { - "description": "the domain associated with the provider", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The domain associated with the provider", "name": "domain", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "The ID of the ovs", + "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", + "description": "The project ID of the IP address", "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the address", + "description": "The project name of the address", "name": "project", "type": "string" }, - { - "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": "Path of the domain to which the provider belongs", + "name": "domainpath", "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": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - {} + "description": "The physical Network service provider id of the provider", + "name": "nspid", + "type": "string" + } ] }, { - "description": "associate a profile to a blade", + "description": "Associate a profile to a blade", "isasync": true, "name": "associateUcsProfileToBlade", "params": [ { - "description": "profile dn", + "description": "Profile dn", "length": 255, "name": "profiledn", "required": true, "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "associated ucs profile dn", + "description": "Associated UCS profile dn", "name": "profiledn", "type": "string" }, - { - "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": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ucs manager id", + "description": "UCS manager ID", "name": "ucsmanagerid", "type": "string" - } - ] - }, - { - "description": "Checks the 2FA code for the user.", - "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", - "params": [ - { - "description": "two factor authentication code", - "length": 255, - "name": "codefor2fa", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "true 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": "UCS blade dn", + "name": "bladedn", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "UCS blade ID", + "name": "id", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "CloudStack host ID this blade associates to", + "name": "hostid", "type": "string" - }, - {} - ], - "since": "4.18.0" + } + ] }, { "description": "Updates a VMware datacenter details for a zone", "isasync": false, "name": "updateVmwareDc", "params": [ + { + "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 zone ID", "length": 255, @@ -31494,20 +31420,6 @@ "required": true, "type": "uuid" }, - { - "description": "The username required to connect to resource.", - "length": 255, - "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 password for specified username.", "length": 255, @@ -31528,44 +31440,90 @@ "name": "vcenter", "required": false, "type": "string" + }, + { + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, + "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + }, {}, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the Zone ID associated with this VMware Datacenter", + "description": "The Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, { - "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 VMware Datacenter ID", - "name": "id", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" - }, + } + ], + "since": "4.12.0" + }, + { + "description": "Checks the 2FA code for the user.", + "isasync": false, + "name": "validateUserTwoFactorAuthenticationCode", + "params": [ + { + "description": "Two factor authentication code", + "length": 255, + "name": "codefor2fa", + "required": true, + "type": "string" + } + ], + "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "True 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.12.0" + "since": "4.18.0" }, { "description": "Starts a router.", @@ -31573,14 +31531,14 @@ "name": "getRouterHealthCheckResults", "params": [ { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "description": "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", + "description": "The ID of the router", "length": 255, "name": "routerid", "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", @@ -31591,94 +31549,94 @@ "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "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" }, + {}, + {}, { - "description": "the id of the router", + "description": "The ID of the router", "name": "routerid", "type": "string" - }, - {}, - {} + } ], "since": "4.14.0" }, { - "description": "list control center", + "description": "List control center", "isasync": false, "name": "listNetscalerControlCenter", "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "UUID", + "name": "uuid", "type": "string" }, { - "description": "username", - "name": "username", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ncc_ip", + "name": "ipaddress", "type": "string" }, { - "description": "uuid", - "name": "uuid", + "description": "Number of retries", + "name": "numretries", "type": "string" }, {}, + {}, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "id", + "description": "ID", "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "num_retries", - "name": "numretries", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -31689,23 +31647,29 @@ "name": "resizeVolume", "params": [ { - "description": "the ID of the disk volume", + "description": "The ID of the disk volume", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, { - "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", + "description": "Verify OK to Shrink", "length": 255, - "name": "automigrate", + "name": "shrinkok", "required": false, - "since": "4.20.1", "type": "boolean" }, { - "description": "new disk offering id", + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, + { + "description": "New disk offering ID", "length": 255, "name": "diskofferingid", "related": "createDiskOffering,listDiskOfferings", @@ -31727,173 +31691,88 @@ "type": "long" }, { - "description": "Verify OK to Shrink", + "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", "length": 255, - "name": "shrinkok", + "name": "automigrate", "required": false, + "since": "4.20.1", "type": "boolean" - }, - { - "description": "New minimum number of IOPS", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", + "description": "The date the volume was attached to an Instance", "name": "attached", "type": "date" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the list of resource tags associated", + "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": "tag key name", - "name": "key", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" } @@ -31901,271 +31780,350 @@ "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, - {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "Name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", + "description": "The write (IO) of disk on the Instance", "name": "diskiowrite", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "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 path of the volume", - "name": "path", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + {}, + { + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "The ID of the device on User Instance the volume is attached 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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", + "description": "An alternate display text of the Template for the Instance", "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "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": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "The project name of the VPN", + "name": "project", "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 project name of the vpn", - "name": "project", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "bytes write rate of the disk volume", + "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": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "True if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "pod name of the volume", + "description": "Pod name of the volume", "name": "podname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The status of the volume", + "name": "status", "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": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "Cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "The bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "State of the Instance", + "name": "vmstate", + "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" } ] }, @@ -32175,66 +32133,66 @@ "name": "deleteAffinityGroup", "params": [ { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "name", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "the domain ID of account owning the affinity group", + "description": "The project of the affinity group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "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,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "The domain ID of account owning the affinity group", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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", + "description": "The 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", + "description": "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" + }, {} ] }, @@ -32244,39 +32202,40 @@ "name": "addNsxController", "params": [ { - "description": "NSX controller / provider name", + "description": "Transport Zone controls to which hosts a logical switch can reach", "length": 255, - "name": "name", + "name": "transportzone", "required": true, "type": "string" }, { - "description": "Username to log into NSX controller", + "description": "NSX controller port", "length": 255, - "name": "username", - "required": true, + "name": "nsxproviderport", + "required": false, "type": "string" }, { - "description": "Password to login into NSX controller", + "description": "Tier-0 Gateway address", "length": 255, - "name": "password", + "name": "tier0gateway", "required": true, "type": "string" }, { - "description": "Edge Cluster name", + "description": "Password to login into NSX controller", "length": 255, - "name": "edgecluster", + "name": "password", "required": true, "type": "string" }, { - "description": "NSX controller port", + "description": "the ID of zone", "length": 255, - "name": "nsxproviderport", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "NSX controller hostname / IP address", @@ -32286,24 +32245,23 @@ "type": "string" }, { - "description": "Tier-0 Gateway address", + "description": "NSX controller / provider name", "length": 255, - "name": "tier0gateway", + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Edge Cluster name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "edgecluster", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Transport Zone controls to which hosts a logical switch can reach", + "description": "Username to log into NSX controller", "length": 255, - "name": "transportzone", + "name": "username", "required": true, "type": "string" } @@ -32311,8 +32269,13 @@ "related": "listNsxControllers,deleteNsxController", "response": [ { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "description": "NSX controller hostname or IP address", + "name": "hostname", + "type": "string" + }, + { + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", "type": "string" }, { @@ -32321,52 +32284,47 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "NSX controller port", + "name": "port", "type": "string" }, { - "description": "NSX controller hostname or IP address", - "name": "hostname", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", "type": "string" }, { - "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", - "name": "tier0gateway", + "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", "type": "string" }, { - "description": "NSX controller port", - "name": "port", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "Zone name to which the NSX controller is associated with", "name": "zonename", "type": "string" }, { - "description": "Zone ID to which the NSX controller is associated with", - "name": "zoneid", + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" }, - {}, { - "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, + {}, { - "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", - "name": "transportzone", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.19.0" }, @@ -32376,7 +32334,7 @@ "name": "deleteNetworkOffering", "params": [ { - "description": "the ID of the network offering", + "description": "The ID of the network offering", "length": 255, "name": "id", "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", @@ -32385,28 +32343,28 @@ } ], "response": [ + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -32415,6 +32373,13 @@ "isasync": true, "name": "updateStorageNetworkIpRange", "params": [ + { + "description": "The netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, { "description": "Optional. the vlan the ip range sits on", "length": 255, @@ -32423,92 +32388,85 @@ "type": "integer" }, { - "description": "the netmask for storage network", + "description": "UUID of storage network ip range", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the beginning IP address", + "description": "The beginning IP address", "length": 255, "name": "startip", "required": false, "type": "string" }, { - "description": "the ending IP address", + "description": "The ending IP address", "length": 255, "name": "endip", "required": false, "type": "string" - }, - { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The UUID of storage Network IP range.", + "name": "id", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "The Network UUID of storage Network IP range", + "name": "networkid", "type": "string" }, + {}, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "The 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 gateway of the storage network IP range", - "name": "gateway", + "description": "The netmask of the storage Network IP range", + "name": "netmask", "type": "string" }, { - "description": "the ID or VID of the VLAN.", + "description": "The ID or VID of the VLAN.", "name": "vlan", "type": "integer" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "The Pod UUID for the storage Network IP range", + "name": "podid", "type": "string" }, { - "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", + "description": "The end IP of the storage Network IP range", + "name": "endip", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "The start IP of the storage Network IP range", + "name": "startip", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -32520,14 +32478,7 @@ "name": "dedicatePod", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the Pod", + "description": "The ID of the Pod", "length": 255, "name": "podid", "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", @@ -32535,7 +32486,14 @@ "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "The name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The ID of the containing domain", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -32546,47 +32504,47 @@ "related": "listDedicatedPods", "response": [ { - "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 Account Id to which the Pod is dedicated", - "name": "accountid", - "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", + "description": "The ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "The Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "The Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the ID of the Pod", - "name": "podid", + "description": "The domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -32595,18 +32553,18 @@ "name": "createGpuCard", "params": [ { - "description": "the device name of the GPU card", + "description": "the device ID of the GPU card", "length": 255, - "name": "devicename", + "name": "deviceid", "required": true, "type": "string" }, { - "description": "the video RAM size in MB for the passthrough vGPU profile", + "description": "the vendor ID of the GPU card", "length": 255, - "name": "videoram", - "required": false, - "type": "long" + "name": "vendorid", + "required": true, + "type": "string" }, { "description": "the display name of the GPU card", @@ -32623,38 +32581,42 @@ "type": "string" }, { - "description": "the vendor ID of the GPU card", + "description": "the video RAM size in MB for the passthrough vGPU profile", "length": 255, - "name": "vendorid", - "required": true, - "type": "string" + "name": "videoram", + "required": false, + "type": "long" }, { - "description": "the device ID of the GPU card", + "description": "the device name of the GPU card", "length": 255, - "name": "deviceid", + "name": "devicename", "required": true, "type": "string" } ], "related": "updateGpuCard,listGpuCards", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" }, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the device ID of the GPU card", "name": "deviceid", @@ -32662,13 +32624,13 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { @@ -32676,11 +32638,7 @@ "name": "name", "type": "string" }, - { - "description": "the ID of the GPU card", - "name": "id", - "type": "string" - } + {} ], "since": "4.21.0" }, @@ -32690,7 +32648,7 @@ "name": "synchronizeTungstenFabricData", "params": [ { - "description": "provider id", + "description": "Provider ID", "length": 255, "name": "id", "related": "createTungstenFabricProvider,listTungstenFabricProviders", @@ -32700,26 +32658,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "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", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, {} ] }, @@ -32729,11 +32687,11 @@ "name": "listVgpuProfiles", "params": [ { - "description": "", + "description": "name of the vGPU profile", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -32751,11 +32709,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the GPU card ID associated with this GPU device", @@ -32766,31 +32724,31 @@ "type": "uuid" }, { - "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", + "description": "List by keyword", "length": 255, - "name": "activeonly", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "name of the vGPU profile", + "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", "length": 255, - "name": "name", + "name": "activeonly", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createVgpuProfile,updateVgpuProfile", "response": [ { - "description": "the maximum number of vGPUs per physical GPU", - "name": "maxvgpuperphysicalgpu", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the ID of the GPU card", - "name": "id", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { "description": "the display name of the GPU card", @@ -32798,44 +32756,33 @@ "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" }, { "description": "the vendor ID of the GPU card", "name": "vendorid", "type": "string" }, - {}, { - "description": "the name of the vGPU profile", - "name": "gpucardname", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the vendor name of the GPU card", - "name": "vendorname", - "type": "string" - }, - { - "description": "the ID of the GPU card associated with this vGPU profile", - "name": "gpucardid", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { @@ -32844,18 +32791,24 @@ "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, {}, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -32863,6 +32816,11 @@ "description": "the description of the vGPU profile", "name": "description", "type": "string" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" } ], "since": "4.21.0" @@ -32880,18 +32838,18 @@ "type": "long" }, { - "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, - "name": "startdate", + "name": "resourcetype", "required": false, - "type": "date" + "type": "string" }, { - "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", + "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "resourcetype", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", @@ -32904,26 +32862,26 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting 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.20" }, @@ -32933,25 +32891,24 @@ "name": "changeOfferingForVolume", "params": [ { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "miniops", + "name": "shrinkok", "required": false, - "type": "long" + "type": "boolean" }, { - "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,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "new disk offering id", + "description": "The ID of the volume", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, @@ -32963,135 +32920,74 @@ "type": "long" }, { - "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": "New disk offering ID", "length": 255, - "name": "shrinkok", - "required": false, - "type": "boolean" + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "maxiops", + "name": "automigrate", "required": false, - "type": "long" + "type": "boolean" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "State of the Instance", + "name": "vmstate", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", "type": "map" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 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 id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "The project id of the VPN", + "name": "projectid", + "type": "string" }, { "description": "ID of the disk offering", @@ -33099,316 +32995,378 @@ "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, + {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Shared or local storage", + "name": "storagetype", "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 state of the disk volume", - "name": "state", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "Pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "The bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "name of the service offering for root disk", + "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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", + "description": "True if storage Snapshot is supported for the volume, false otherwise", "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "type of the virtual machine", + "description": "Type of the Instance", "name": "vmtype", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the bytes allocated", + "description": "The bytes allocated", "name": "virtualsize", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", + "description": "An alternate display text of the Template for the Instance", "name": "templatedisplaytext", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "The date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "Name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "ID of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 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": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, - {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "pod id of the volume", + "description": "Pod id of the volume", "name": "podid", "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": "ID of the disk volume", - "name": "id", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "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 ID of the 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 Instance", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" } ], "since": "4.17" @@ -33419,15 +33377,14 @@ "name": "deleteLdapConfiguration", "params": [ { - "description": "ID of the LDAP configuration", + "description": "Port", "length": 255, - "name": "id", - "related": "addLdapConfiguration,deleteLdapConfiguration,listLdapConfigurations", + "name": "port", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "linked domain", + "description": "Linked domain", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -33435,54 +33392,55 @@ "type": "uuid" }, { - "description": "port", + "description": "Hostname", "length": 255, - "name": "port", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Hostname", + "description": "ID of the LDAP configuration", "length": 255, - "name": "hostname", + "name": "id", + "related": "addLdapConfiguration,deleteLdapConfiguration,listLdapConfigurations", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addLdapConfiguration,listLdapConfigurations", "response": [ { - "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the LDAP configuration", - "name": "id", + "description": "Name of the host running the LDAP server", + "name": "hostname", "type": "string" }, + {}, { - "description": "linked domain", + "description": "Linked domain", "name": "domainid", "type": "string" }, { - "description": "port the ldap server is running on", + "description": "the ID of the LDAP configuration", + "name": "id", + "type": "string" + }, + { + "description": "Port the LDAP server is running on", "name": "port", "type": "int" - }, - {}, - {} + } ], "since": "4.2.0" }, @@ -33500,55 +33458,55 @@ "type": "uuid" }, { - "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" }, { - "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" } ], "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "the description of the role", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The description of the role", "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the project", + "name": "projectid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, + {}, { - "description": "the id of the project", - "name": "projectid", + "description": "The ID of the role", + "name": "id", "type": "string" }, { - "description": "the name of the role", + "description": "The name of the role", "name": "name", "type": "string" }, @@ -33557,235 +33515,235 @@ "since": "4.15.0" }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", + "description": "Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)", "isasync": true, "name": "createIpv6FirewallRule", "params": [ { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "description": "The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "The source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "Type of the ICMP message being sent", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "The destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, "name": "destcidrlist", "required": false, "type": "list" }, { - "description": "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" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "The starting port of Ipv6 firewall rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "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 source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "The ending port of Ipv6 firewall rule", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "The Network of the Instance the Ipv6 firewall rule will be created for", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Error code for this ICMP message", "length": 255, - "name": "fordisplay", + "name": "icmpcode", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "response": [ + {}, + {}, { - "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 ID of the port forwarding rule", + "description": "The ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "The Instance 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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", + "description": "The starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "The current status of the latest 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 ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "The public IP address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "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": "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 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 ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag value", - "name": "value", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the port forwarding rule", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "The protocol of the port forwarding rule", "name": "protocol", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "The Instance IP address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the state of the rule", + "description": "The state of the rule", "name": "state", "type": "string" } @@ -33797,7 +33755,7 @@ "name": "triggerShutdown", "params": [ { - "description": "the id of the management server", + "description": "The UUID of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", @@ -33808,44 +33766,36 @@ "related": "prepareForMaintenance,cancelMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "The number of host agents this management server is responsible for", - "name": "agentscount", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" }, { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "type": "boolean" }, + {}, { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, + {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" }, { "description": "Indicates whether a shutdown has been triggered", @@ -33853,12 +33803,20 @@ "type": "boolean" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" }, - {}, - {} + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + } ], "since": "4.19.0" }, @@ -33867,37 +33825,6 @@ "isasync": true, "name": "updateNetwork", "params": [ - { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", - "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": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, { "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, @@ -33907,11 +33834,11 @@ "type": "integer" }, { - "description": "the new name for the network", + "description": "An optional field, whether to the display the network to the end User or not.", "length": 255, - "name": "name", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Setting this to true will cause a forced network update,", @@ -33921,7 +33848,7 @@ "type": "boolean" }, { - "description": "network offering ID", + "description": "Network offering ID", "length": 255, "name": "networkofferingid", "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", @@ -33929,66 +33856,74 @@ "type": "uuid" }, { - "description": "Force update even if CIDR type is different", + "description": "When true IP address usage for the Network will not be exported by the listUsageRecords API", "length": 255, - "name": "changecidr", + "name": "hideipaddressusage", "required": false, "type": "boolean" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", "length": 255, - "name": "guestvmcidr", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "network domain", + "description": "Network domain", "length": 255, "name": "networkdomain", "required": false, "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "The first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", "length": 255, - "name": "hideipaddressusage", + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "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 first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "The second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", "length": 255, - "name": "ip6dns1", + "name": "dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the new display text for the network", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "displaytext", + "name": "guestvmcidr", "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "The new name for the network", "length": 255, - "name": "ip6dns2", + "name": "name", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "description": "The first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", "length": 255, - "name": "sourcenatipaddress", + "name": "dns1", "required": false, - "since": "4.19", + "since": "4.18.0", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "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, @@ -33996,52 +33931,101 @@ "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "The ID of the network", "length": 255, - "name": "displaynetwork", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "The new display text for the network", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "Force update even if CIDR type is different", + "length": 255, + "name": "changecidr", "required": false, "type": "boolean" }, { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "description": "The second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", "length": 255, - "name": "dns1", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" + }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "The type of the Network", + "name": "type", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "True if Network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The details of the Network", + "name": "details", + "type": "map" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ACL name associated with the VPC Network", + "name": "aclname", "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", + "type": "string" + }, + { + "description": "The domain ID of the Network owner", + "name": "domainid", + "type": "string" }, { "description": "The routes for the network to ease adding route in upstream router", @@ -34049,306 +34033,236 @@ "type": "set" }, { - "description": "true network requires restart", - "name": "restartrequired", + "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", + "type": "string" + }, + { + "description": "True if guest Network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The list of resource tags associated with Network", "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": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", + "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": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "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 owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "An optional field, whether to the display the Network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "True if Network supports specifying IP ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "the physical network id", + "description": "The physical Network id", "name": "physicalnetworkid", "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "The ID of the Network", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "True if Network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "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": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "The Network's netmask", + "name": "netmask", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the list of services", + "description": "The list of services", "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", + "description": "The service provider name", "name": "provider", "response": [ { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "UUID of the Network provider", + "name": "id", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "The provider name", + "name": "name", "type": "string" }, { - "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 physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "Services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" }, { - "description": "the list of capabilities", + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", + "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", + "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" @@ -34357,196 +34271,248 @@ "type": "list" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "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's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + {}, + { + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "List Networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The internet protocol of Network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "True if Network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "The first IPv4 DNS for the Network", + "name": "dns1", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The displaytext of the Network", + "name": "displaytext", "type": "string" }, { - "description": "zone id of the network", + "description": "Zone ID of the Network", "name": "zoneid", "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, - {}, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "Network offering ID the Network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "Related to what other Network configuration", + "name": "related", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "The date this Network was created", + "name": "created", + "type": "date" + }, + { + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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": "State of the Network", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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": "state of the network", - "name": "state", + "description": "VPC the Network belongs to", + "name": "vpcid", "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "The second IPv4 DNS for the Network", + "name": "dns2", + "type": "string" + }, + { + "description": "ACL type - access type to the Network", + "name": "acltype", + "type": "string" } ] }, { - "description": "Lists VM backups", + "description": "Lists Instance backups", "isasync": false, "name": "listBackups", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "ID of the Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, @@ -34560,22 +34526,22 @@ "type": "integer" }, { - "description": "list backups by name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "since": "4.21.0", - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -34583,15 +34549,37 @@ "type": "uuid" }, { - "description": "id of the VM", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List backups by zone id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "id of the backup", + "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 backups with VM details", + "length": 255, + "name": "listvmdetails", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "ID of the backup", "length": 255, "name": "id", "related": "updateBackupSchedule,listBackups", @@ -34606,30 +34594,7 @@ "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list backups with VM details", - "length": 255, - "name": "listvmdetails", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "list backups by backup offering", + "description": "list backups by backup offering", "length": 255, "name": "backupofferingid", "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", @@ -34638,44 +34603,47 @@ "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 backups by zone id", + "description": "list backups by name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" } ], "related": "updateBackupSchedule", "response": [ { - "description": "domain id", - "name": "domainid", + "description": "Zone name", + "name": "zone", "type": "string" }, + {}, + {}, { - "description": "backup type", - "name": "type", + "description": "Name of the Instance", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "account id", - "name": "accountid", + "description": "Backup offering name", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "Domain name", + "name": "domain", + "type": "string" + }, + { + "description": "description for the backup", + "name": "description", + "type": "string" + }, + { + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" }, { "description": "The backup offering corresponding to this backup was removed from the VM", @@ -34683,44 +34651,34 @@ "type": "boolean" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "Account id", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ID of the VM", + "description": "ID of the Instance", "name": "virtualmachineid", "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", - "type": "string" - }, - { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "account name", - "name": "account", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "description for the backup", - "name": "description", + "description": "Backup type", + "name": "type", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Lists the vm specific details for the backup", @@ -34728,19 +34686,19 @@ "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Account name", + "name": "account", + "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "zone name", - "name": "zone", - "type": "string" + "description": "Backup date", + "name": "created", + "type": "date" }, { "description": "name of the backup", @@ -34748,44 +34706,44 @@ "type": "string" }, { - "description": "zone id", - "name": "zoneid", - "type": "string" + "description": "Backup status", + "name": "status", + "type": "status" }, { - "description": "backup date", - "name": "created", - "type": "date" + "description": "Backup offering id", + "name": "backupofferingid", + "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "External backup id", + "name": "externalid", "type": "string" }, { - "description": "domain name", - "name": "domain", + "description": "Domain ID", + "name": "domainid", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "Backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "Interval type of the backup", - "name": "intervaltype", + "description": "ID of the Instance backup", + "name": "id", "type": "string" }, { - "description": "Indicates whether the VM from which the backup was taken is expunged or not", - "name": "isbackupvmexpunged", - "type": "boolean" + "description": "Backup size in bytes", + "name": "size", + "type": "long" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "Backed up volumes", + "name": "volumes", + "type": "string" } ], "since": "4.14.0" @@ -34797,32 +34755,32 @@ "params": [], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Usage type description", + "name": "description", "type": "string" }, + {}, + {}, { "description": "Usage type name", "name": "name", "type": "string" }, - {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Usage type ID", "name": "id", "type": "integer" }, { - "description": "Usage type description", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -34842,24 +34800,24 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the CA service provider", + "description": "The description of the CA service provider", "name": "description", "type": "string" }, { - "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 CA service provider name", + "name": "name", + "type": "string" }, {}, {} @@ -34883,44 +34841,50 @@ "related": "listNsxControllers", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { - "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", - "name": "tier0gateway", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", "type": "string" }, { - "description": "Zone ID to which the NSX controller is associated with", - "name": "zoneid", + "description": "NSX controller name", + "name": "name", "type": "string" }, { - "description": "NSX controller port", - "name": "port", + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Zone name to which the NSX controller is associated with", - "name": "zonename", + "description": "NSX controller port", + "name": "port", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", "name": "transportzone", "type": "string" }, + {}, { - "description": "NSX controller hostname or IP address", - "name": "hostname", + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", "type": "string" }, { @@ -34929,16 +34893,10 @@ "type": "string" }, { - "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", - "type": "string" - }, - { - "description": "NSX controller name", - "name": "name", + "description": "NSX controller hostname or IP address", + "name": "hostname", "type": "string" - }, - {} + } ], "since": "4.19.0" }, @@ -34948,11 +34906,26 @@ "name": "updateGuiTheme", "params": [ { - "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "description": "The ID of the theme to be updated.", "length": 255, - "name": "recursivedomains", + "name": "id", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", + "required": true, + "type": "uuid" + }, + { + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", + "required": false, + "type": "string" }, { "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", @@ -34962,26 +34935,25 @@ "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "length": 65535, - "name": "commonnames", + "description": "A description for the theme.", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "The ID of the theme to be updated.", + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", "length": 255, - "name": "id", - "related": "listGuiThemes,updateGuiTheme,createGuiTheme", - "required": true, - "type": "uuid" + "name": "recursivedomains", + "required": false, + "type": "boolean" }, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "length": 65535, - "name": "domainids", + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "length": 255, + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", @@ -34998,25 +34970,11 @@ "type": "string" }, { - "description": "A name to identify the theme.", - "length": 2048, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "A description for the theme.", - "length": 4096, - "name": "description", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", "required": false, "type": "string" - }, - { - "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" } ], "related": "listGuiThemes,createGuiTheme", @@ -35027,72 +34985,72 @@ "type": "string" }, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "domainids", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, - {}, { "description": "Description of the GUI theme.", "name": "description", "type": "string" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", - "type": "boolean" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "accountids", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", "type": "string" }, { - "description": "ID of the custom GUI theme.", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" - }, { "description": "When the GUI theme was created.", "name": "created", "type": "date" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "jsonconfiguration", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, { - "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", - "name": "ispublic", - "type": "boolean" + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" }, { - "description": "Name of the GUI theme.", - "name": "name", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "name": "commonnames", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", + "type": "boolean" + } ], "since": "4.21.0.0" }, @@ -35102,7 +35060,7 @@ "name": "deleteVPC", "params": [ { - "description": "the ID of the VPC", + "description": "The ID of the VPC", "length": 255, "name": "id", "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", @@ -35111,35 +35069,43 @@ } ], "response": [ - {}, {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", + "description": "Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool", "isasync": true, "name": "migrateVirtualMachine", "params": [ + { + "description": "The ID of the Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "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, @@ -35149,7 +35115,7 @@ "type": "boolean" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume", "length": 255, "name": "storageid", "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", @@ -35157,1179 +35123,1176 @@ "type": "uuid" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "Destination Host ID to migrate Instance to.", "length": 255, "name": "hostid", "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" - }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The project name of the Instance", + "name": "project", "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 in KiB", - "name": "networkkbsread", - "type": "long" + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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 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 value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 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 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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "Tag value", + "name": "value", + "type": "string" }, { - "description": "the account owning the security group", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "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 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 associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, - {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the speed of each vCPU", + "description": "The speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", + "description": "Device ID for the Network when plugged into the Instance", "name": "deviceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 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 gateway of IPv6 network", + "description": "The gateway of IPv6 Network", "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "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 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 CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, - { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, { "description": "the count of GPUs on the virtual machine", "name": "gpucount", "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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 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": "User VM type", - "name": "vmtype", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", + "description": "The target memory in Instance (KiB)", "name": "memorytargetkbs", "type": "long" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, { "description": "the video RAM size in MB", "name": "videoram", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, + {}, + {}, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the 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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, { "description": "dedicated resources associated with this affinity group", "name": "dedicatedresources", "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "The ID of the affinity group", "name": "id", "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": "the domain ID of the affinity group", - "name": "domainid", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The group ID of the Instance", + "name": "groupid", "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", + "response": [ { - "description": "tag key name", - "name": "key", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "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 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 ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "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": "Security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The project id of the group", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The domain name of the security group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The amount of the Instance's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the virtual machine", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "The name of the Instance", "name": "name", "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" } ] }, @@ -36349,24 +36312,24 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True 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", + "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", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -36379,7 +36342,7 @@ "name": "deleteKubernetesSupportedVersion", "params": [ { - "description": "the ID of the Kubernetes supported version", + "description": "The ID of the Kubernetes supported version", "length": 255, "name": "id", "related": "addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", @@ -36388,41 +36351,41 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + {}, + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { - "description": "list baremetal rack configuration", + "description": "List baremetal rack configuration", "isasync": false, "name": "listBaremetalRct", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -36432,36 +36395,36 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "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": "url", - "name": "url", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "id of rct", + "description": "ID of RCT", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "URL", + "name": "url", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -36481,37 +36444,37 @@ "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 UUID of the latest async job acting on 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", + "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 CA service provider name", + "name": "name", + "type": "string" + }, + {} ], "since": "4.11.0" }, { - "description": "Delete site to site vpn customer gateway", + "description": "Delete site to site VPN customer gateway", "isasync": true, "name": "deleteVpnCustomerGateway", "params": [ { - "description": "id of customer gateway", + "description": "ID of customer gateway", "length": 255, "name": "id", "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", @@ -36520,28 +36483,28 @@ } ], "response": [ + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "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" - }, - {} + } ] }, { @@ -36550,258 +36513,258 @@ "name": "listPortForwardingRules", "params": [ { - "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 resources by account. Must be used with the domainId parameter.", + "description": "List port forwarding rules for certain network", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "list port forwarding rules for certain network", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "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": "list only resources belonging to the domain specified", + "description": "The ID of IP address of the port forwarding services", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the list of resource tags associated with the rule", + "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 Instance name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "The ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The 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 Instance IP address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "The public IP address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + {}, { - "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 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 protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", + "description": "The Instance 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": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the state of the rule", + "description": "The state of the rule", "name": "state", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - {}, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "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": "publicendport", "type": "string" } ] @@ -36812,50 +36775,41 @@ "name": "acquirePodIpAddress", "params": [ { - "description": "Pod ID", + "description": "The ID of the zone", "length": 255, - "name": "podid", + "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "string" }, { - "description": "the ID of the zone", + "description": "Pod ID", "length": 255, - "name": "zoneid", + "name": "podid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "Gateway for Pod ", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the pod the IP address", - "name": "id", + "description": "The ID of the pod the IP address belongs to", + "name": "podid", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 pod the IP address", + "name": "id", "type": "long" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "CIDR of the Pod", "name": "cidr", @@ -36867,15 +36821,24 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "MAC address of the pod the IP", + "name": "hostmac", "type": "long" }, - {}, { - "description": "MAC address of the pod the IP", - "name": "hostmac", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the NIC", + "name": "nicid", "type": "long" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -36885,7 +36848,7 @@ "name": "enableOutOfBandManagementForCluster", "params": [ { - "description": "the ID of the cluster", + "description": "The ID of the cluster", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -36896,97 +36859,82 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", + "description": "True if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - {}, - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "The out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "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 password", - "name": "password", + "description": "The out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", + "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 ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "The operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface address", + "description": "The out-of-band management interface address", "name": "address", "type": "string" - } + }, + { + "description": "The out-of-band management interface port", + "name": "port", + "type": "string" + }, + {}, + {} ], "since": "4.9.0" }, { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", + "description": "Updates a Template visibility permissions. A public Template is visible to all accounts within the same domain. A private Template is visible only to the owner of the Template. A privileged Template is a private Template with account permissions added. Only accounts specified under the Template permissions are visible to them.", "isasync": false, "name": "updateTemplatePermissions", "params": [ { - "description": "a comma delimited list of projects. 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": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, - { - "description": "the template ID", + "description": "The Template ID", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -36994,28 +36942,43 @@ "type": "uuid" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "True if the Template/ISO is extractable, false otherwise. Can be set only by root admin", "length": 255, "name": "isextractable", "required": false, "type": "boolean" }, { - "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": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, + { + "description": "True for featured Template/ISO, false otherwise", "length": 255, "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "A comma delimited list of Accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, "name": "accounts", "required": false, "type": "list" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "Permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "True for public Template/ISO, false for private Templates/ISOs", "length": 255, "name": "ispublic", "required": false, @@ -37023,32 +36986,32 @@ } ], "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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": "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]", + "description": "Resets the password for Instance. The Instance 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": [ @@ -37061,583 +37024,285 @@ "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the format of the template for the virtual machine", + "description": "The format of the template for the virtual machine", "name": "templateformat", "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The name of the ISO attached to the Instance", + "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 incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "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": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", + "description": "The memory allocated for the Instance", "name": "memory", "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The name of the security group", + "name": "name", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", + "description": "The ID of the security group", "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "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", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "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 description of the security group", - "name": "description", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "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": "account owning the security group rule", + "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": "Security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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 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": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", + "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 value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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": "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": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" } @@ -37645,32 +37310,22 @@ "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": "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", + "description": "The protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", + "description": "The ID of the security group rule", "name": "ruleid", "type": "string" } @@ -37678,325 +37333,268 @@ "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", + "description": "The number of Instances associated with this Security Group", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the security group", + "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The 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": "security group name", - "name": "securitygroupname", + "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", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", + "description": "The code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "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" - }, - { - "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 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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "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", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, - {}, - {}, { - "description": "User VM type", - "name": "vmtype", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "the maximum Y resolution", @@ -38004,110 +37602,343 @@ "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "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 VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "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 extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The type of the NIC", + "name": "type", "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "The ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", + "description": "The number of vCPUs this Instance is using", "name": "cpunumber", "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "The project name of the Instance", + "name": "project", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "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": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { @@ -38116,116 +37947,253 @@ "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, { "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "The domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "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", + "description": "The project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", + "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" } ] }, @@ -38244,27 +38212,27 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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.21.0" @@ -38274,6 +38242,14 @@ "isasync": false, "name": "listBrocadeVcsDevices", "params": [ + { + "description": "The Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -38281,6 +38257,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "Brocade VCS switch ID", "length": 255, @@ -38295,89 +38278,74 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ + { + "description": "Name of the provider", + "name": "provider", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of the Brocade Vcs", + "description": "Device ID of the Brocade Vcs", "name": "vcsdeviceid", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", + "description": "The physical Network to which this Brocade VCS belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "The principal switch IP address", + "name": "hostname", "type": "string" }, + {}, { - "description": "device name", + "description": "Device name", "name": "brocadedevicename", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" - }, - {} + } ] }, { - "description": "link an existing cloudstack domain to group or OU in ldap", + "description": "Link an existing Cloudstack domain to group or OU in ldap", "isasync": false, "name": "linkDomainToLdap", "params": [ { - "description": "name of the group or OU in LDAP", + "description": "Name of the group or OU in LDAP", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "type of the ldap name. GROUP or OU", + "description": "Name of the group or OU in LDAP", "length": 255, - "name": "type", - "required": true, + "name": "ldapdomain", + "required": false, "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "Type of the ldap name. GROUP or OU", "length": 255, - "name": "accounttype", + "name": "type", "required": true, - "type": "integer" + "type": "string" }, { "description": "The id of the domain which has to be linked to LDAP.", @@ -38388,63 +38356,63 @@ "type": "uuid" }, { - "description": "domain admin username in LDAP ", + "description": "Domain admin username in LDAP ", "length": 255, "name": "admin", "required": false, "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", - "required": false, - "type": "string" + "name": "accounttype", + "required": true, + "type": "integer" } ], "related": "linkAccountToLdap", "response": [ + {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", + "description": "Name of the group or OU in LDAP which is linked to the domain", "name": "ldapdomain", "type": "string" }, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "type of the name in LDAP which is linked to the domain", + "description": "Type of the name in LDAP which is linked to the domain", "name": "type", "type": "string" }, - { - "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", + "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", + "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" }, - {}, { "description": "Domain Admin accountId that is created", "name": "accountid", "type": "string" + }, + { + "description": "Type of the Account to auto import", + "name": "accounttype", + "type": "int" } ], "since": "4.6.0" @@ -38462,7 +38430,7 @@ "type": "boolean" }, { - "description": "the id of the management server", + "description": "The UUID of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", @@ -38472,57 +38440,57 @@ ], "related": "prepareForMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, { "description": "The number of host agents this management server is responsible for", "name": "agentscount", "type": "long" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, { "description": "The id of the management server", "name": "managementserverid", "type": "string" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" }, { "description": "Indicates whether maintenance has been initiated", "name": "maintenanceinitiated", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" } ], "since": "4.21.0" @@ -38533,109 +38501,108 @@ "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "two factor authentication code", + "description": "Two factor authentication code", "length": 255, "name": "provider", "required": false, "type": "string" }, { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "Enabled by default, provide false to disable 2FA", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "enable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Enabled by default, provide false to disable 2FA", + "description": "Optional: the id of the User for which 2FA has to be disabled", "length": 255, - "name": "enable", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the account ID of the user", - "name": "accountid", + "description": "Secret code that needs to be registered with authenticator", + "name": "secretcode", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user ID", + "description": "The user ID", "name": "id", "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 name", - "name": "username", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" } ], "since": "4.18.0" }, { - "description": "Lists site to site vpn customer gateways", + "description": "Lists site to site VPN customer gateways", "isasync": false, "name": "listVpnCustomerGateways", "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,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "id of the customer gateway", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "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": "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": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -38643,149 +38610,150 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "ID of the customer gateway", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "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": "the project name", - "name": "project", + "description": "Guest IP of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "The project ID", + "name": "projectid", + "type": "string" }, - {}, { - "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", "name": "ikeversion", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the vpn gateway ID", - "name": "id", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "The domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the owner", + "description": "The domain ID of the owner", "name": "domainid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "The project name", + "name": "project", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "Name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "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 (,).", + "description": "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "The owner", + "name": "account", "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": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "The domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "Public IP address ID of the customer gateway", + "name": "gateway", "type": "string" } ] @@ -38796,7 +38764,15 @@ "name": "deleteKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "The ID of the Kubernetes cluster", "length": 255, "name": "id", "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", @@ -38810,36 +38786,28 @@ "required": false, "since": "4.19.0", "type": "boolean" - }, - { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "true 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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -38851,24 +38819,23 @@ "name": "listWebhooks", "params": [ { - "description": "The scope of the Webhook", + "description": "List by keyword", "length": 255, - "name": "scope", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The ID of the Webhook", + "description": "", "length": 255, - "name": "id", - "related": "createWebhook,listWebhooks,listWebhookDeliveries", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "The name of the Webhook", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -38880,43 +38847,51 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "The ID of the Webhook", "length": 255, - "name": "page", + "name": "id", + "related": "createWebhook,listWebhooks,listWebhookDeliveries", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The scope of the Webhook", "length": 255, - "name": "account", + "name": "scope", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "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": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 objects by project; if projectid=-1 lists All VMs", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -38924,35 +38899,29 @@ "type": "uuid" }, { - "description": "The name of the Webhook", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" } ], "related": "createWebhook,listWebhookDeliveries", "response": [ { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, + {}, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { @@ -38961,121 +38930,73 @@ "type": "date" }, { - "description": "The scope of the Webhook", - "name": "scope", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, - { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" - }, { "description": "The name of the Webhook", "name": "name", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "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 Kubernetes cluster", - "name": "project", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { "description": "The description of the Webhook", "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists and switches to other SAML accounts owned by the SAML user", - "isasync": false, - "name": "listAndSwitchSamlAccount", - "params": [ - { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" }, { - "description": "Domain uuid", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } - ] + ], + "since": "4.20.0" }, { "description": "Creates a global load balancer rule", @@ -39083,35 +39004,29 @@ "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "Session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "The domain ID associated with the load balancer", "length": 255, - "name": "gslbdomainname", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "name of the load balancer rule", + "description": "Name of the load balancer rule", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", - "length": 255, - "name": "gslblbmethod", - "required": false, - "type": "string" - }, - { - "description": "region where the global load balancer is going to be created.", + "description": "Region where the global load balancer is going to be created.", "length": 255, "name": "regionid", "related": "addRegion,updateRegion,listRegions", @@ -39119,22 +39034,28 @@ "type": "integer" }, { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "description": "The description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "Domain name for the GSLB service.", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "gslbdomainname", + "required": true, + "type": "string" + }, + { + "description": "Load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "length": 255, + "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "The Account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, @@ -39151,260 +39072,260 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "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": "GSLB service type", - "name": "gslbservicetype", + "description": "The domain ID of the Load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "description": "The project ID of the Load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the account of the load balancer rule", + "description": "Load balancing method used for the global Load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "The description of the global Load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "The project name of the Load balancer", + "name": "project", + "type": "string" + }, + { + "description": "The Account of the Load balancer rule", "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Global Load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "Name of the global Load balancer rule", + "name": "name", + "type": "string" + }, { "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "type": "string" }, + {}, { - "description": "global load balancer rule ID", - "name": "id", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", + "description": "List of Load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "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 ID of the guest Network the LB rule belongs to", + "name": "networkid", + "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 domain of the load balancer rule", - "name": "domain", + "description": "The project ID of the Load balancer", + "name": "projectid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the load balancer rule ID", + "description": "The Load balancer rule ID", "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "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 public IP address ID", + "name": "publicipid", + "type": "string" + }, + { + "description": "The project name of the Load balancer", + "name": "project", + "type": "string" + }, + { + "description": "The public port", + "name": "publicport", + "type": "string" + }, + { + "description": "The list of resource tags associated with Load balancer", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The 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": "tag key name", - "name": "key", + "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 CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "The protocol of the Load Balancer rule", + "name": "protocol", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account of the load balancer rule", + "description": "The Account of the Load balancer rule", "name": "account", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "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", + "description": "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the load balancer", + "description": "The name of the Load balancer", "name": "name", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "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", + "description": "The description of the Load balancer", + "name": "description", "type": "string" } ], "type": "list" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - {}, - { - "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": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", + "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", + "description": "Region ID in which global Load balancer is created", + "name": "regionid", "type": "integer" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" } ] }, @@ -39414,7 +39335,7 @@ "name": "deleteNetscalerLoadBalancer", "params": [ { - "description": "netscaler load balancer device ID", + "description": "Netscaler load balancer device ID", "length": 255, "name": "lbdeviceid", "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", @@ -39424,26 +39345,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -39453,90 +39374,90 @@ "name": "listTags", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list by customer name", + "description": "List by key", "length": 255, - "name": "customer", + "name": "key", "required": false, "type": "string" }, { - "description": "list by resource id", + "description": "List by resource ID", "length": 255, "name": "resourceid", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by value", + "description": "List by value", "length": 255, "name": "value", "required": false, "type": "string" }, { - "description": "", + "description": "List by customer name", "length": 255, - "name": "page", + "name": "customer", "required": false, - "type": "integer" + "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 by key", + "description": "List by resource type", "length": 255, - "name": "key", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by resource type", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "resourcetype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -39549,72 +39470,72 @@ "related": "listResourceDetails", "response": [ { - "description": "tag value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Account associated with the 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 account associated with the tag", - "name": "account", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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 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 key name", - "name": "key", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" - }, - {} + } ], "since": "4.0.0" }, @@ -39623,6 +39544,13 @@ "isasync": false, "name": "listAffectedVmsForStorageScopeChange", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -39631,25 +39559,18 @@ "type": "string" }, { - "description": "the Id of the storage pool on which change scope operation is being done", + "description": "the Id of the cluster the scope of the storage pool is being changed to", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the Id of the cluster the scope of the storage pool is being changed to", + "description": "the Id of the storage pool on which change scope operation is being done", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" }, @@ -39663,31 +39584,24 @@ ], "related": "", "response": [ - {}, - {}, - { - "description": "the name of the VM", - "name": "name", - "type": "string" - }, { - "description": "the hostname for the VM", - "name": "hostname", + "description": "the type of VM", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the VM", + "name": "id", "type": "string" }, { - "description": "the host ID for the VM", - "name": "hostid", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, { - "description": "the ID of the VM", - "name": "id", + "description": "the cluster name for the VM", + "name": "clustername", "type": "string" }, { @@ -39695,20 +39609,27 @@ "name": "clusterid", "type": "string" }, + {}, { - "description": "the type of VM", - "name": "type", + "description": "the name of the VM", + "name": "name", "type": "string" }, { - "description": "the cluster name for the VM", - "name": "clustername", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host ID for the VM", + "name": "hostid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.1" @@ -39719,79 +39640,79 @@ "name": "createVirtualRouterElement", "params": [ { - "description": "the network service provider ID of the virtual router element", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "nspid", + "name": "providertype", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": true, + "required": false, "type": "uuid" }, { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", + "description": "The network service provider ID of the virtual router element", "length": 255, - "name": "providertype", + "name": "nspid", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": false, + "required": true, "type": "uuid" } ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ + {}, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the physical network service provider id of the provider", + "description": "The physical Network service provider ID of the provider", "name": "nspid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "The ID of the router", + "name": "id", + "type": "string" }, {}, { - "description": "the account associated with the provider", + "description": "The Account associated with the provider", "name": "account", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "The domain ID associated with the provider", + "name": "domainid", "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 domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" } ] @@ -39802,38 +39723,44 @@ "name": "createVPC", "params": [ { - "description": "the second IPv4 DNS for the VPC", + "description": "The name of the VPC", "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "name": "name", + "required": true, "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", + "length": 255, + "name": "userouteripresolver", + "required": false, + "type": "boolean" + }, + { + "description": "VPC Network domain. All Networks inside the VPC will belong to this domain", "length": 255, "name": "networkdomain", "required": false, "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.3", - "type": "boolean" + "type": "uuid" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "Create VPC for the project", "length": 255, - "name": "ip6dns1", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "MTU to be configured on the Network VR's public facing interfaces", "length": 255, "name": "publicmtu", "required": false, @@ -39841,11 +39768,28 @@ "type": "integer" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "The ID of the availability zone", "length": 255, - "name": "displaytext", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first Network gets implemented. True by default.", + "length": 255, + "name": "start", "required": false, - "type": "string" + "since": "4.3", + "type": "boolean" }, { "description": "the AS Number of the VPC tiers", @@ -39856,41 +39800,34 @@ "type": "long" }, { - "description": "create VPC for the project", + "description": "The Account associated with the VPC. 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": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "The second IPv6 DNS for the VPC", "length": 255, - "name": "cidr", + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "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 CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "cidrsize", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "integer" }, { - "description": "the name of the VPC", + "description": "The first IPv4 DNS for the VPC", "length": 255, - "name": "name", - "required": true, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { @@ -39903,131 +39840,278 @@ "type": "list" }, { - "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "An optional field, whether to the display the VPC to the end User or not", "length": 255, - "name": "sourcenatipaddress", + "name": "fordisplay", "required": false, - "since": "4.19", - "type": "string" - }, - { - "description": "the ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "The first IPv6 DNS for the VPC", "length": 255, - "name": "account", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "The second IPv4 DNS for the VPC", "length": 255, - "name": "dns1", + "name": "dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", - "length": 255, - "name": "userouteripresolver", - "required": false, - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the VPC", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "ip6dns2", + "name": "displaytext", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "The CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDR", "length": 255, - "name": "fordisplay", + "name": "cidr", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "description": "IPv4 address to be assigned to the public interface of the Network router.This address will be used as source NAT address for the Networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the Network won´t be implemented,", "length": 255, - "name": "cidrsize", + "name": "sourcenatipaddress", "required": false, - "since": "4.20.0", - "type": "integer" + "since": "4.19", + "type": "string" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + { + "description": "The owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "The name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "Is VPC for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "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": "The provider name", + "name": "name", + "type": "string" + }, + { + "description": "UUID of the Network provider", + "name": "id", + "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "State of the Network provider", + "name": "state", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "The list of Networks belonging to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "If this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, { "description": "The routes for the VPC to ease adding route in upstream router", "name": "ip4routes", "type": "set" }, + {}, + { + "description": "An alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "State of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "The domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "The CIDR the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "Zone ID of the VPC", + "name": "zoneid", + "type": "string" + }, + { + "description": "VPC offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + {}, + { + "description": "Does VPC use distributed router for one hop forwarding and host based Network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "The ID of the VPC", + "name": "id", + "type": "string" + }, { - "description": "the list of resource tags associated with the project", + "description": "The list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project 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 name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" } @@ -40035,8 +40119,18 @@ "type": "list" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "The second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "The date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "The first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { @@ -40045,257 +40139,84 @@ "type": "set" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "The project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "The Network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the VPC", + "description": "The name of the VPC", "name": "name", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - {}, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "vpc offering id the VPC is created from", + "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 project ID of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the domain id of the VPC owner", + "description": "The domain ID of the VPC owner", "name": "domainid", "type": "string" }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "AS NUMBER", "name": "asnumber", "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", + "description": "The first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "true VPC requires restart", + "description": "True VPC requires restart", "name": "restartrequired", "type": "boolean" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, - {}, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" + "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", + "description": "True if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" } ] }, @@ -40305,17 +40226,17 @@ "name": "removeResourceDetail", "params": [ { - "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" }, { @@ -40327,28 +40248,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", + "description": "Any text associated with the 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", + "description": "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" + }, + {} ] }, { @@ -40357,19 +40278,13 @@ "name": "listOsTypes", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list by Os type Id", + "description": "Comma separated list of OS types", "length": 255, - "name": "id", + "name": "ids", "related": "listOsTypes,addGuestOs", "required": false, - "type": "uuid" + "since": "4.22.1", + "type": "list" }, { "description": "List by keyword", @@ -40378,14 +40293,6 @@ "required": false, "type": "string" }, - { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories,addOsCategory", - "required": false, - "type": "uuid" - }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -40402,63 +40309,86 @@ "type": "integer" }, { - "description": "list os by description", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List OS by description", "length": 255, "name": "description", "required": false, "since": "3.0.1", "type": "string" + }, + { + "description": "List by OS type ID", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "List by OS Category ID", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", + "required": false, + "type": "uuid" } ], "related": "addGuestOs", "response": [ { - "description": "the name of the OS category", - "name": "oscategoryname", + "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 name of the OS type", + "name": "name", + "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "description": "Is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "is the guest OS visible for the users", + "description": "Is the guest OS visible for the users", "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the OS type", + "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", + "description": "The ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "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": "the name of the OS type", - "name": "name", + "description": "The name of the OS category", + "name": "oscategoryname", "type": "string" - }, - {} + } ] }, { @@ -40467,31 +40397,31 @@ "name": "updateGpuCard", "params": [ { - "description": "the ID of the GPU card", + "description": "the display name of the GPU card", "length": 255, - "name": "id", - "related": "updateGpuCard,listGpuCards", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the vendor name of the GPU card", + "description": "the device name of the GPU card", "length": 255, - "name": "vendorname", + "name": "devicename", "required": false, "type": "string" }, { - "description": "the display name of the GPU card", + "description": "the ID of the GPU card", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "updateGpuCard,listGpuCards", + "required": true, + "type": "uuid" }, { - "description": "the device name of the GPU card", + "description": "the vendor name of the GPU card", "length": 255, - "name": "devicename", + "name": "vendorname", "required": false, "type": "string" } @@ -40499,35 +40429,36 @@ "related": "listGpuCards", "response": [ { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, + {}, { "description": "the vendor name of the GPU card", "name": "vendorname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the device ID of the GPU card", - "name": "deviceid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the display name of the GPU card", @@ -40535,11 +40466,10 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + } ], "since": "4.21.0" }, @@ -40559,24 +40489,24 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -40584,7 +40514,7 @@ "since": "4.4.0" }, { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", + "description": "Detaches any ISO file (if any) currently attached to an Instance.", "isasync": true, "name": "detachIso", "params": [ @@ -40597,1002 +40527,830 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 read (IO) of disk on the VM", + "description": "The read (IO) of disk on the Instance", "name": "diskioread", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "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 name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "The memory used by the Instance 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", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "The name of the Template for the Instance", + "name": "templatename", "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", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance 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 name of the Instance", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "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": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the format of the template for the virtual machine", + "description": "The format of the template for the virtual machine", "name": "templateformat", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the 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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "security group name", + "description": "Security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The 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": "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": "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", + "description": "The protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the 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" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "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 number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "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", + "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": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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 project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", + "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": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", + "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 security group rule", + "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", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", + "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 code for the ICMP message response", - "name": "icmpcode", + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" } ], "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": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "set" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" }, - {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The internal memory (KiB) that's free in Instance 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": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the traffic type of the nic", + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The traffic type of the NIC", "name": "traffictype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "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 Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -41601,166 +41359,343 @@ "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "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", + "description": "The Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "the ID of the corresponding network", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of the nic", + "description": "The gateway of the NIC", "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "the extra dhcp options on the nic", + "description": "The extra DHCP options on the NIC", "name": "extradhcpoption", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "Instance lease duration in days", "name": "leaseduration", "type": "integer" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "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 outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "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": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingid", "type": "string" }, { - "description": "the pool type of the virtual machine", + "description": "The pool type of the Instance", "name": "pooltype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -41771,18 +41706,19 @@ "name": "updateCustomAction", "params": [ { - "description": "Type of the resource for actions", + "description": "Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName", "length": 255, - "name": "resourcetype", + "name": "errormessage", "required": false, "type": "string" }, { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", + "description": "ID of the custom action", "length": 255, - "name": "timeout", - "required": false, - "type": "integer" + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": true, + "type": "uuid" }, { "description": "Success message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionName", @@ -41792,9 +41728,9 @@ "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", "length": 255, - "name": "details", + "name": "parameters", "required": false, "type": "map" }, @@ -41806,33 +41742,25 @@ "type": "boolean" }, { - "description": "The description of the command", - "length": 255, - "name": "description", - "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 action, details field ignored; if false or not set, no action)", + "description": "Whether the action is enabled or not", "length": 255, - "name": "cleanupdetails", + "name": "enabled", "required": false, "type": "boolean" }, { - "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", "length": 255, - "name": "parameters", + "name": "details", "required": false, "type": "map" }, { - "description": "ID of the custom action", + "description": "Type of the resource for actions", "length": 255, - "name": "id", - "related": "addCustomAction,listCustomActions", - "required": true, - "type": "uuid" + "name": "resourcetype", + "required": false, + "type": "string" }, { "description": "List of role types allowed for the action", @@ -41842,42 +41770,49 @@ "type": "list" }, { - "description": "Whether the action is enabled or not", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", "length": 255, - "name": "enabled", + "name": "timeout", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName", + "description": "The description of the command", "length": 255, - "name": "errormessage", + "name": "description", "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 action, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "description": "Any text associated with the 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.21.0" @@ -41897,28 +41832,28 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", + "description": "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": "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -41933,13 +41868,6 @@ "required": false, "type": "string" }, - { - "description": "Payload URL of the Webhook delivery", - "length": 255, - "name": "payloadurl", - "required": false, - "type": "string" - }, { "description": "The ID of the Webhook delivery for redelivery", "length": 255, @@ -41948,6 +41876,13 @@ "required": false, "type": "uuid" }, + { + "description": "Payload URL of the Webhook delivery", + "length": 255, + "name": "payloadurl", + "required": false, + "type": "string" + }, { "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", "length": 255, @@ -41974,45 +41909,34 @@ "related": "", "response": [ { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", - "type": "string" - }, - { - "description": "The type of the event", - "name": "eventtype", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The end time of the Webhook delivery", + "name": "enddate", + "type": "date" }, { - "description": "The ID of the Webhook delivery", - "name": "id", + "description": "The ID of the Webhook", + "name": "webhookid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", "type": "string" }, { - "description": "The end time of the Webhook delivery", - "name": "enddate", + "description": "The start time of the Webhook delivery", + "name": "startdate", "type": "date" }, { - "description": "Whether Webhook delivery succeeded or not", - "name": "success", - "type": "boolean" + "description": "The payload of the webhook delivery", + "name": "payload", + "type": "string" }, {}, { - "description": "The ID of the event", - "name": "eventid", + "description": "The type of the event", + "name": "eventtype", "type": "string" }, { @@ -42021,13 +41945,13 @@ "type": "string" }, { - "description": "The payload of the webhook delivery", - "name": "payload", + "description": "The name of the management server which executed delivery", + "name": "managementservername", "type": "string" }, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -42035,20 +41959,31 @@ "name": "headers", "type": "string" }, + {}, { - "description": "The ID of the Webhook", - "name": "webhookid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the event", + "name": "eventid", "type": "string" }, + { + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, { "description": "The response of the webhook delivery", "name": "response", "type": "string" }, { - "description": "The start time of the Webhook delivery", - "name": "startdate", - "type": "date" + "description": "The ID of the Webhook delivery", + "name": "id", + "type": "string" } ], "since": "4.20.0" @@ -42059,7 +41994,7 @@ "name": "deletePod", "params": [ { - "description": "the ID of the Pod", + "description": "The ID of the Pod", "length": 255, "name": "id", "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", @@ -42069,26 +42004,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", + "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", + "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" } ] }, @@ -42098,77 +42033,82 @@ "name": "listTungstenFabricProviders", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "createTungstenFabricProvider", "response": [ { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, {}, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, + { + "description": "True if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, { "description": "Tungsten-Fabric provider port", "name": "tungstenproviderport", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { @@ -42177,19 +42117,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -42199,18 +42134,18 @@ "name": "listDeploymentPlanners", "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": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -42222,23 +42157,23 @@ ], "related": "", "response": [ - { - "description": "Deployment Planner name", - "name": "name", - "type": "string" - }, - {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "Deployment Planner name", + "name": "name", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -42247,7 +42182,7 @@ "name": "deleteCluster", "params": [ { - "description": "the cluster ID", + "description": "The cluster ID", "length": 255, "name": "id", "related": "addCluster,updateCluster", @@ -42257,27 +42192,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", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { @@ -42286,7 +42221,7 @@ "name": "prepareHostForMaintenance", "params": [ { - "description": "the host ID", + "description": "The host ID", "length": 255, "name": "id", "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", @@ -42297,121 +42232,49 @@ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the host out-of-band management information", + "description": "The host out-of-band management information", "name": "outofbandmanagement", "type": "outofbandmanagementresponse" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "CPU Arch of the host", + "name": "arch", "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "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 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 name of the host", - "name": "name", + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "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 percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "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": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "The CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - {}, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - {}, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The ID of the host", + "name": "id", + "type": "string" }, { "description": "GPU cards present in the host", @@ -42423,7 +42286,7 @@ "type": "string" }, { - "description": "the list of enabled vGPUs", + "description": "The list of enabled vGPUs", "name": "vgpu", "response": [ { @@ -42431,40 +42294,40 @@ "name": "videoram", "type": "long" }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", + "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 Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { "description": "Maximum displays per user", "name": "maxheads", "type": "long" + }, + { + "description": "Maximum vGPU can be created with this vGPU type on the given GPU group", + "name": "maxcapacity", + "type": "long" } ], "type": "list" @@ -42472,236 +42335,287 @@ ], "type": "list" }, + {}, { - "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": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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 host type", + "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", - "type": "string" + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", + "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 host hypervisor", - "name": "hypervisor", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "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": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", + "description": "The average CPU 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 amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "Comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, + { + "description": "The date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "comma-separated list of explicit host tags for the host", "name": "explicithosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the CPU number of the host", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "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 admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "The Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The Pod ID of the host", + "name": "podid", "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 percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The name of extension for this cluster", + "name": "extensionname", "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 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 Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "Events available for the host", + "name": "events", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "The amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "The OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "Capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", @@ -42709,40 +42623,61 @@ "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + {}, + { + "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", + "type": "long" }, { - "description": "the state of the host", + "description": "The state of the host", "name": "state", "type": "status" - } - ] - }, - { - "description": "Removes specified region", - "isasync": false, + }, + { + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" + } + ] + }, + { + "description": "Removes specified region", + "isasync": false, "name": "removeRegion", "params": [ { @@ -42755,26 +42690,26 @@ ], "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "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" } ] }, @@ -42794,257 +42729,257 @@ "related": "", "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, { - "description": "Updates an existing autoscale vm group.", + "description": "Updates an existing autoscale Instance group.", "isasync": true, "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "An optional field, whether to the display the group to the end user or not", "length": 255, - "name": "maxmembers", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the autoscale group", + "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": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "The minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.", "length": 255, - "name": "interval", + "name": "minmembers", "required": false, "type": "integer" }, { - "description": "list of scaledown autoscale policies", + "description": "The ID of the autoscale group", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "The name of the autoscale vmgroup", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "list of scaleup autoscale policies", + "description": "The maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "maxmembers", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the name of the autoscale vmgroup", + "description": "The frequency in which the performance counters to be collected", "length": 255, - "name": "name", + "name": "interval", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "List of scaledown autoscale policies", "length": 255, - "name": "customid", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "List of scaleup autoscale policies", "length": 255, - "name": "minmembers", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "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 Load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The current state of the AutoScale Instance Group", + "name": "state", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", + "description": "The LB provider of the guest Network the LB rule belongs to", "name": "lbprovider", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vm group", - "name": "project", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "List of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "List of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "The minimum number of members in the Instance Group, the number of Instances in the Instance 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": "Is group for display to the regular User", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the date when this vm group was created", + "description": "The date when this Instance group was created", "name": "created", "type": "date" }, { - "description": "the public ip address", - "name": "publicip", + "description": "The id of the guest Network the LB rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "The public IP address ID", + "name": "publicipid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain ID of the Instance group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "The frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, + {}, { - "description": "the 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 maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.", "name": "maxmembers", "type": "int" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "The autoscale profile that contains information about the Instances in the Instance group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "The project id of the Instance group", + "name": "projectid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The autoscale Instance group ID", + "name": "id", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "The name of the guest Network the LB rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The name of the autoscale Instance group ", + "name": "name", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "The project name of the Instance group", + "name": "project", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The public port", + "name": "publicport", + "type": "string" + }, + { + "description": "The private port", + "name": "privateport", + "type": "string" } ] }, { - "description": "Deletes a snapshot of a disk volume.", + "description": "Deletes a Snapshot of a disk volume.", "isasync": true, "name": "deleteSnapshot", "params": [ { - "description": "The ID of the snapshot", + "description": "The ID of the Snapshot", "length": 255, "name": "id", "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", @@ -43063,115 +42998,99 @@ ], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on 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": "List the virtual machines owned by the account.", + "description": "List the Instances owned by the account.", "isasync": false, "name": "listVirtualMachines", "params": [ { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" - }, - { - "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 Instances by affinity group", "length": 255, - "name": "state", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", "length": 255, - "name": "pagesize", + "name": "gpuenabled", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the host ID", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "List by the service offering", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the security group ID", + "description": "List by Network ID", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "haenable", + "name": "state", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The group ID", "length": 255, - "name": "isrecursive", + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the group ID", + "description": "List Instances by Template", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "description": "Flag to display the resource icon for Instances", "length": 255, "name": "showicon", "required": false, @@ -43179,32 +43098,31 @@ "type": "boolean" }, { - "description": "list vms by iso", + "description": "The ID of AutoScaling Instance Group", "length": 255, - "name": "isoid", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "the cluster ID", + "description": "The host ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "since": "4.16.0", "type": "uuid" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "extensionid", - "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "name": "tags", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "map" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "The user ID that created the Instance and is under the Account that owns the Instance", "length": 255, "name": "userid", "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", @@ -43212,7 +43130,14 @@ "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": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -43220,715 +43145,343 @@ "type": "uuid" }, { - "description": "list by the backup offering", + "description": "Accumulates the Instance 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": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "accumulate", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "List by Network type; true if need to list Instances using Virtual Network, false otherwise", "length": 255, - "name": "name", + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "List Instances by SSH keypair name", + "length": 255, + "name": "keypair", "required": false, "type": "string" }, { - "description": "list vms by template", + "description": "The storage ID where Instance's volumes belong to", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "description": "The IDs of the Instances, mutually exclusive with id", "length": 255, - "name": "gpuenabled", + "name": "ids", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.21.0", - "type": "boolean" + "since": "4.4", + "type": "list" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "userdata", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "keypair", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The availability zone ID", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the instances by userdata", + "description": "The ID of the Instance", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "id", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.20.1", "type": "uuid" }, { - "description": "CPU arch of the 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": "arch", + "name": "listall", "required": false, - "since": "4.20.1", - "type": "string" + "type": "boolean" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "description": "The pod ID", "length": 255, - "name": "details", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Whether to return only leased instances", + "description": "", "length": 255, - "name": "leased", + "name": "pagesize", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "forvirtualnetwork", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the target hypervisor for the template", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "hypervisor", + "name": "extensionid", + "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Whether to return the Instances' User data or not. By default, User data will not be returned.", "length": 255, - "name": "displayvm", + "name": "userdata", "required": false, - "since": "4.4", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "the availability zone ID", + "description": "List Instances by ISO", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The security group ID", "length": 255, - "name": "account", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, - "type": "string" + "since": "4.15", + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "The target hypervisor for the Template", "length": 255, - "name": "tags", + "name": "hypervisor", "required": false, - "type": "map" + "type": "string" }, { - "description": "the ID of AutoScaling VM Group", + "description": "List Instances by VPC", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.18.0", "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": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "accumulate", + "name": "displayvm", "required": false, - "since": "4.17.0", + "since": "4.4", "type": "boolean" }, { - "description": "the pod ID", + "description": "Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "List by the backup offering", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "name": "haenable", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "The cluster ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "since": "4.16.0", "type": "uuid" }, { - "description": "", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "page", + "name": "isvnf", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list vms by vpc", + "description": "Whether to return only leased instances", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "leased", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list by the service offering", + "description": "CPU arch of the VM", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "arch", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { - "description": "List by keyword", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "keyword", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by network id", + "description": "the instances by userdata", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, + "since": "4.20.1", "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "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": "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" - } - ], - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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 code for the ICMP message response", - "name": "icmpcode", - "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the virtual network for the service offering", + "description": "The virtual Network for the service offering", "name": "forvirtualnetwork", "type": "boolean" }, + {}, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The state of the Instance", + "name": "state", "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { "description": "the maximum X resolution", @@ -43936,73 +43489,48 @@ "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", + "description": "The pool type of the Instance", "name": "pooltype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { @@ -44011,519 +43539,860 @@ "type": "date" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the availability zone for the virtual machine", + "description": "The ID of the availability zone for the Instance", "name": "zoneid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "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 number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The name of the Template for the Instance", + "name": "templatename", "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": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "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 Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The name of the service offering of the Instance", + "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 read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", + "description": "The project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "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 project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" } ], "type": "set" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "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": "CPU arch of the VM", - "name": "arch", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, - {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "The Account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - {}, { - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The name of the security group", + "name": "name", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "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 Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The project id of the group", + "name": "projectid", "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 ID of the nic", - "name": "id", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The Account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The 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": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + } + ], + "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 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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the isolation uri of the nic", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "description": "The isolation URI of the NIC", "name": "isolationuri", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "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", @@ -44531,47 +44400,67 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the 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 corresponding network", - "name": "networkid", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the extra dhcp options on the nic", + "description": "The extra DHCP options on the NIC", "name": "extradhcpoption", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "The ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", + "description": "The netmask of the NIC", "name": "netmask", "type": "string" }, @@ -44581,27 +44470,78 @@ "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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 password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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" } ] }, @@ -44611,54 +44551,71 @@ "name": "listDiskOfferings", "params": [ { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "ID of the disk offering", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "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,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "since": "4.17", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "account", + "name": "storagetype", "required": false, + "since": "4.19", "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": "ID of the disk offering", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "state", + "required": false, + "since": "4.19", + "type": "string" + }, + { + "description": "List only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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" }, { "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "since": "4.20.0", "type": "uuid" }, { - "description": "id of zone disk offering is associated with", + "description": "ID of zone disk offering is associated with", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -44667,31 +44624,28 @@ "type": "uuid" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "List by keyword", "length": 255, - "name": "storagetype", + "name": "keyword", "required": false, - "since": "4.19", "type": "string" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "since": "4.19", - "type": "string" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Name of the disk offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "listed offerings support disk encryption", + "description": "Listed offerings support disk encryption", "length": 255, "name": "encrypt", "required": false, @@ -44699,254 +44653,240 @@ "type": "boolean" }, { - "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": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "since": "4.17", "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "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 only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" } ], "related": "createDiskOffering", "response": [ { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "The tags for the disk offering", + "name": "tags", + "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 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", + "description": "The vsphere storage policy tagged to the disk offering in case of VMware", "name": "vspherestoragepolicy", "type": "string" }, - {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "Burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "True if disk offering uses custom IOPS, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "True if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "Unique ID of the disk offering", + "name": "id", + "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "I/O requests read rate of the disk offering", "name": "diskIopsReadRate", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "I/O requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "Additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "The size of the disk offering in GB", + "name": "disksize", "type": "long" }, - { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, { "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "name": "disksizestrictness", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "Bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "Whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the disk offering", + "name": "state", "type": "string" }, + {}, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "Length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "The min IOPS of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "The name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "The max IOPS of the disk offering", + "name": "maxiops", "type": "long" }, { - "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": "the date this disk offering was created", + "description": "The date this disk offering was created", "name": "created", "type": "date" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "Burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", "name": "provisioningtype", "type": "string" }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, { "description": "Whether disks using this offering will be encrypted on primary storage", "name": "encrypt", "type": "boolean" }, { - "description": "state of the disk offering", - "name": "state", + "description": "An alternate display text of the disk offering.", + "name": "displaytext", "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": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "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" + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" } ] }, @@ -44965,26 +44905,26 @@ } ], "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", + "description": "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" } ] @@ -44995,7 +44935,7 @@ "name": "upgradeKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "The ID of the Kubernetes cluster", "length": 255, "name": "id", "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", @@ -45003,7 +44943,7 @@ "type": "uuid" }, { - "description": "the ID of the Kubernetes version for upgrade", + "description": "The ID of the Kubernetes version for upgrade", "length": 255, "name": "kubernetesversionid", "related": "addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", @@ -45014,90 +44954,90 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "The size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, - {}, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", + "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 Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "The description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "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", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "The name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, + {}, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { "description": "Name of CNI Configuration associated with the cluster", @@ -45105,150 +45045,155 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "The state of the Kubernetes cluster", + "name": "state", "type": "string" }, - {}, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "The memory the Kubernetes cluster", + "name": "memory", "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 Kubernetes cluster", - "name": "name", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "The 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": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", "type": "boolean" }, { - "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": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "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": "The ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "The list of virtualmachines associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "The ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, + {}, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { "description": "URL end point for the Kubernetes cluster", @@ -45256,38 +45201,17 @@ "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Creates a condition for VM auto scaling", + "description": "Creates a condition for Instance auto scaling", "isasync": true, "name": "createCondition", "params": [ - { - "description": "an optional project for condition", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - }, { "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, @@ -45303,98 +45227,114 @@ "type": "long" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "The account of the condition. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the domain ID of the account.", + "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "An optional project for condition", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "listConditions", "response": [ { - "description": "the owner of the Condition.", - "name": "account", + "description": "The project name of the Condition", + "name": "project", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, + {}, { - "description": "zone id of counter", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "The Name of the Counter.", + "name": "countername", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "The domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the project name of the Condition", - "name": "project", + "description": "The ID of the Condition", + "name": "id", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "The project ID of the Condition.", + "name": "projectid", + "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "The owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "Zone ID of counter", + "name": "zoneid", "type": "string" }, + {}, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "The ID of the Counter.", + "name": "counterid", + "type": "string" + }, + { + "description": "The domain ID of the Condition owner", + "name": "domainid", "type": "string" } ] @@ -45405,88 +45345,87 @@ "name": "listProjects", "params": [ { - "description": "list projects by name", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list 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,moveDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List projects by username", + "description": "List projects by name", "length": 255, - "name": "username", + "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,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list projects by display text", + "description": "", "length": 255, - "name": "displaytext", + "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 projects by state", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list projects by project ID", + "description": "Flag to display the resource icon for projects", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the resource icon for projects", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "list" + "type": "map" }, { - "description": "", + "description": "List projects by username", "length": 255, - "name": "page", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list projects by state", + "description": "List projects by display text", "length": 255, - "name": "state", + "name": "displaytext", "required": false, "type": "string" }, @@ -45498,378 +45437,375 @@ "type": "integer" }, { - "description": "List projects by tags (key/value pairs)", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "List by keyword", + "description": "Comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "keyword", + "name": "details", "required": false, - "type": "string" + "type": "list" } ], "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the name of the project", - "name": "name", + "description": "The displaytext of the project", + "name": "displaytext", "type": "string" }, { - "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 gpus the project can own", - "name": "gpulimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "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", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "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", + "description": "The total number of Instances that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "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) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "The list of resource tags associated with Instance", + "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 Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "The total number of VPCs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "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", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "The total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The total number of CPU cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "The total number of public IP addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "The total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "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 total number of Templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "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 tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "The domain ID the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "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", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", + "description": "The total memory (in MB) the project can own", "name": "memorylimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "The Account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "The total number of Networks owned by project", + "name": "networktotal", "type": "long" }, + {}, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "The total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "The total number of public IP addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "The state of the project", + "name": "state", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "The total number of VPCs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" + "description": "The date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "The total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", - "type": "string" + "description": "The total number of VPCs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "The total number of Networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "The name of the project", + "name": "name", + "type": "string" }, { - "description": "the domain name where the project belongs to", + "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 project Account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "The total number of Instances deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", - "type": "string" + "description": "The total number of Templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The total number of Instances running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "The total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "The total number of Templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "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 number of templates available to be created by this project", - "name": "templateavailable", + "description": "The total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "The total volume available for this project", + "name": "volumeavailable", "type": "string" }, { @@ -45878,21 +45814,25 @@ "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "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 number of snapshots available for this project", - "name": "snapshotavailable", + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "type": "string" }, - {} + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + } ], "since": "3.0.0" }, @@ -45902,48 +45842,26 @@ "name": "createAccount", "params": [ { - "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": "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": "First name", "length": 255, - "name": "account", - "required": false, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "User UUID, required for adding Account from external provisioning system", "length": 255, - "name": "accountid", + "name": "userid", "required": false, "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "description": "Network domain for the account's networks", + "description": "E-mail", "length": 255, - "name": "networkdomain", - "required": false, + "name": "email", + "required": true, "type": "string" }, - { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "Unique username.", "length": 255, @@ -45960,23 +45878,16 @@ "type": "uuid" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, - "type": "string" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "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": "timezone", + "name": "account", "required": false, "type": "string" }, { - "description": "email", + "description": "Last name", "length": 255, - "name": "email", + "name": "lastname", "required": true, "type": "string" }, @@ -45988,251 +45899,140 @@ "type": "string" }, { - "description": "firstname", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "firstname", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "lastname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "lastname", - "required": true, - "type": "string" - } - ], - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "name": "timezone", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "Account UUID, required for adding Account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "Details for Account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", + "description": "Network domain for the Account's Networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "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 total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The total number of CPU cores the account can own", + "name": "cpulimit", "type": "string" }, - { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, { "description": "the total number of buckets available to this account", "name": "bucketavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "true if account is default, false otherwise", + "description": "True if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", + "description": "The total number of Snapshots stored by this Account", "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "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", - "type": "long" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of vpcs owned by account", + "description": "The total number of VPCs owned by account", "name": "vpctotal", "type": "long" }, + {}, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", + "description": "The total number of projects the Account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", + "description": "The total number of VPCs the Account can own", "name": "vpclimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { @@ -46241,851 +46041,1005 @@ "type": "long" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "The total number of projects being administrated by this Account", + "name": "projecttotal", "type": "long" }, { - "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 tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "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 that can be deployed by this account", - "name": "vmlimit", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "The total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "The state of the account", + "name": "state", "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 cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" - }, - { - "description": "the network domain", + "description": "The Network domain", "name": "networkdomain", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "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 number of Instances running for this Account", + "name": "vmrunning", + "type": "integer" }, { - "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", + "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", + "description": "The total number of Instances available for this Account to acquire", "name": "vmavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" - }, - { - "description": "the list of users associated with account", + "description": "The list of users associated with account", "name": "user", "response": [ { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user state", + "description": "The user state", "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "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 user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date and time the user account was created", + "description": "The date and time the user Account was created", "name": "created", "type": "date" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", + "description": "True if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "The name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "The domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", + "description": "The boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "true if user is default, false otherwise", + "description": "True if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the name of the account", - "name": "name", - "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ], - "type": "set" + "type": "list" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The total number of Networks the Account can own", + "name": "networklimit", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "The total number of Networks owned by Account", + "name": "networktotal", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The total number of public IP addresses available for this Account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "The date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The ID of the Account", + "name": "id", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The total number of Networks available to be created for this Account", + "name": "networkavailable", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "The list of ACL groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "The total number of public IP addresses allocated for this Account", + "name": "iptotal", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The total number of VPCs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Name of the Domain the Account belongs to", + "name": "domain", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "The total number of Templates which can be created by this Account", + "name": "templatelimit", "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 total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The default zone of the Account", + "name": "defaultzoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The total number of Templates which have been created by this Account", + "name": "templatetotal", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The total volume available for this Account", + "name": "volumeavailable", "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": "Revert Instance from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The ID of the Instance Snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "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", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" + }, + { + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The vGPU type used by the Instance", + "name": "vgpu", + "type": "string" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + {}, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The project ID of the affinity group", + "name": "projectid", "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 type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "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": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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", + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { @@ -47094,608 +47048,599 @@ "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The IP address of the NIC", + "name": "ipaddress", + "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": "The IPv6 address of Network", + "name": "ip6address", + "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 Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the affinity group", + "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": "Device ID for the Network when plugged into the Instance", + "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 project name of the affinity group", - "name": "project", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "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 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": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "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", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the project name of the vm", + "description": "The project name of the Instance", "name": "project", "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 VM's primary IP address", - "name": "ipaddress", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", + "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", + "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 type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", + "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" }, { - "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", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the 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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the id of the security group rule", + "description": "The ID of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "account owning the security group rule", + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The 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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The 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": "tag value", - "name": "value", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "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 ending IP of the security group rule ", + "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" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", + "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 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": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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 ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" } ], "since": "4.2.0" @@ -47716,35 +47661,43 @@ ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "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" }, { - "description": "create Tungsten-Fabric service group", + "description": "Create Tungsten-Fabric service group", "isasync": true, "name": "createTungstenFabricServiceGroup", "params": [ + { + "description": "The ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "Tungsten-Fabric service group start port", "length": 255, @@ -47753,19 +47706,18 @@ "type": "integer" }, { - "description": "Tungsten-Fabric service group protocol", + "description": "Tungsten-Fabric service group end port", "length": 255, - "name": "protocol", + "name": "endport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric service group protocol", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Tungsten-Fabric service group name", @@ -47773,54 +47725,42 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "Tungsten-Fabric service group end port", - "length": 255, - "name": "endport", - "required": true, - "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { "description": "Tungsten-Fabric service group uuid", "name": "uuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric service group protocol", "name": "protocol", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Tungsten-Fabric service group start port", "name": "startport", "type": "int" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Tungsten-Fabric service group end port", "name": "endport", @@ -47830,6 +47770,11 @@ "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -47848,26 +47793,26 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", + "description": "True 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" } ], @@ -47879,26 +47824,33 @@ "name": "registerIso", "params": [ { - "description": "true if password reset feature is supported; default is false", + "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": "passwordenabled", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "Image store UUID", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "True if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "isextractable", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "The checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" }, { "description": "Register ISO for the project", @@ -47909,72 +47861,65 @@ "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 CPU arch of the ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "True if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "bootable", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "the name of the ISO", - "length": 255, - "name": "name", + "description": "The URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", "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", + "description": "True if password reset feature is supported; default is false", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if you want this ISO to be featured", + "description": "True if ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "length": 255, - "name": "isfeatured", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "isdynamicallyscalable", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "description": "An optional Account name. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "An optional domainId. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "isextractable", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the zone you wish to register the ISO to.", + "description": "The ID of the zone you wish to register the ISO to.", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -47982,391 +47927,391 @@ "type": "uuid" }, { - "description": "Image store UUID", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "The display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "True if you want to register the ISO to be publicly available to all Users, false otherwise.", "length": 255, - "name": "directdownload", + "name": "ispublic", "required": false, "type": "boolean" }, { - "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": "True if you want this ISO to be featured", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, + "type": "boolean" + }, + { + "description": "The name of the ISO", + "length": 251, + "name": "name", + "required": true, "type": "string" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The Template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "The processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "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 ID of the zone for this template", - "name": "zoneid", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template name", - "name": "name", + "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": "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", + "description": "The size of the Template", + "name": "size", + "type": "long" + }, + { + "description": "True if Template is sshkey enabled, false otherwise", "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "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": "checksum of the template", + "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 secondary storage host for the Template", + "name": "hostname", + "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": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The Account name to which the Template belongs", + "name": "account", + "type": "string" + }, + { + "description": "The name of the OS type for this Template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "The tag of this Template", + "name": "templatetag", + "type": "string" + }, + { + "description": "The type of the Template", + "name": "templatetype", + "type": "string" + }, + { + "description": "The date this Template was created", + "name": "created", + "type": "date" + }, + { + "description": "The date this Template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The ID of the zone for this Template", + "name": "zoneid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the 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 URL which the template/iso is registered from", - "name": "url", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the list of resource tags associated", + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "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": "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", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "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": "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": "the template display text", - "name": "displaytext", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "the physical size of the template", + "description": "The physical size of the Template", "name": "physicalsize", "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "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 id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - } + {} ] }, { @@ -48375,73 +48320,73 @@ "name": "listCiscoAsa1000vResources", "params": [ { - "description": "Cisco ASA 1000v resource ID", + "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": "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,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "The Physical Network ID", "length": 255, - "name": "hostname", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "page", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "addCiscoAsa1000vResource", "response": [ + {}, + {}, {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {}, - {}, - {} + } ] }, { - "description": "deletes a range of portable public IP's associated with a region", + "description": "Deletes a range of portable public IP's associated with a region", "isasync": true, "name": "deletePortableIpRange", "params": [ @@ -48456,67 +48401,67 @@ ], "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "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": "Upgrades router to use newer template", + "description": "Upgrades router to use newer Template", "isasync": false, "name": "upgradeRouterTemplate", "params": [ { - "description": "upgrades router with the specified Id", + "description": "Upgrades all routers within the specified Pod", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "upgrades all routers owned by the specified account", + "description": "Upgrades all routers owned by the specified domain", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "Upgrades all routers owned by the specified account", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers within the specified zone", + "description": "Upgrades router with the specified Id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": false, "type": "uuid" }, { - "description": "upgrades all routers within the specified cluster", + "description": "Upgrades all routers within the specified cluster", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -48524,187 +48469,258 @@ "type": "uuid" }, { - "description": "upgrades all routers within the specified pod", + "description": "Upgrades all routers within the specified zone", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ] }, { - "description": "Cancels host maintenance.", - "isasync": true, - "name": "cancelHostMaintenance", + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "the host ID", + "description": "UUID of VPC to which the IPv4 subnet is associated to.", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "response": [ + }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "UUID of the IPv4 subnet for guest network.", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, + "type": "uuid" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": false, + "type": "uuid" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "UUID of network to which the IPv4 subnet is associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The CIDR of the Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" - }, + } + ], + "related": "createIpv4SubnetForGuestNetwork", + "response": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, + {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "id of the IPv4 subnet for guest network", + "name": "id", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, + {}, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" + } + ], + "since": "4.20.0" + }, + { + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "The host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "response": [ + { + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", + "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 an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "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": "GPU cards present in the host", "name": "gpugroup", "response": [ { - "description": "the list of enabled vGPUs", + "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": "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 no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -48713,23 +48729,23 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "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 Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", "type": "long" } ], @@ -48744,267 +48760,357 @@ "type": "list" }, { - "description": "the cluster ID of the host", + "description": "The cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "Comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "The outgoing Network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "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", + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "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 ID of extension for this cluster", - "name": "extensionid", - "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" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "The OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the resource state of the host", + "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", + "description": "The host version", + "name": "version", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "True if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "The CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "The ID of the host", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The CPU number of the host", + "name": "cpunumber", "type": "integer" }, + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "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": "CPU Arch of the host", + "name": "arch", "type": "string" }, - {}, { - "description": "the Zone name of the host", - "name": "zonename", + "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 admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "The amount of the host's memory currently allocated in bytes", "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "The Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "The host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the date and time the host was created", + "description": "The date and time the host was created", "name": "created", "type": "date" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, - {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the host type", + "description": "The host type", "name": "type", "type": "type" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The state of the host", + "name": "state", + "type": "status" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + {}, + { + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", + "description": "The amount of the host's memory currently allocated in percentage", "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, - {}, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "The last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "The last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" + }, + { + "description": "The number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "The 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": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" } ] }, @@ -49014,68 +49120,59 @@ "name": "listVlanIpRanges", "params": [ { - "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": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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": "The Pod ID of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "network id of the VLAN IP range", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "The account with which the VLAN IP range is associated. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "Project who will own the VLAN", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "physical network id of the VLAN IP range", + "description": "Physical Network ID of the VLAN IP range", "length": 255, "name": "physicalnetworkid", "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", @@ -49083,177 +49180,186 @@ "type": "uuid" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "The ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, "name": "vlan", "required": false, "type": "string" }, { - "description": "", + "description": "Network ID of the VLAN IP range", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "project who will own the 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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "The Zone ID of the VLAN IP range", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "True if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" } ], "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ - {}, { - "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 Pod ID for the VLAN IP range", - "name": "podid", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "The end IP of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "The Network ID of VLAN range", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "The Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The CIDR of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "description": "Indicates whether VLAN IP range is dedicated to System VMs or not", "name": "forsystemvms", "type": "boolean" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "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 description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "The Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "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 or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "The Account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the domain name of the VLAN IP range", + "description": "The domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The start IP of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "The netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "The project ID of the VLAN range", + "name": "projectid", "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 project name of the vlan range", - "name": "project", + "description": "The start IPv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, + {}, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "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 IPv6 Network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "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", + "description": "The ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "The end IPv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "The 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": "Path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" } ] @@ -49264,122 +49370,122 @@ "name": "updateZone", "params": [ { - "description": "sort key of the zone, integer", + "description": "True if local storage offering enabled, false otherwise", "length": 255, - "name": "sortkey", + "name": "localstorageenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "The second internal DNS for the Zone", "length": 255, - "name": "domain", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "The first internal DNS for the Zone", "length": 255, - "name": "dns1", + "name": "internaldns1", "required": false, "type": "string" }, { - "description": "the name of the Zone", + "description": "Updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "name", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", + "description": "The guest CIDR address for the Zone", "length": 255, "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "The details for the Zone", "length": 255, "name": "details", "required": false, "type": "map" }, { - "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 the Zone", + "description": "The first DNS for IPv6 network in the Zone", "length": 255, - "name": "dns2", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "The name of the Zone", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "ip6dns2", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the dns search order list", + "description": "The DNS search order list", "length": 255, "name": "dnssearchorder", "required": false, "type": "list" }, { - "description": "the dhcp Provider for the Zone", + "description": "The DHCP Provider for the Zone", "length": 255, "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "The first DNS for the Zone", "length": 255, - "name": "ispublic", + "name": "dns1", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Zone", + "description": "Sort key of the zone, integer", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the second internal DNS for the Zone", + "description": "The second DNS for IPv6 network in the Zone", "length": 255, - "name": "internaldns2", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "The ID of the Zone", "length": 255, - "name": "internaldns1", - "required": false, - "type": "string" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "ip6dns1", + "name": "domain", "required": false, "type": "string" } @@ -49387,156 +49493,71 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the second DNS for the Zone", + "description": "The second DNS for the Zone", "name": "dns2", "type": "string" }, { - "description": "External network provider if any", - "name": "provider", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "the 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": "the list of resource tags associated with zone.", + "description": "The list of resource tags associated with zone.", "name": "tags", "response": [ { - "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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": "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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } @@ -49544,36 +49565,19 @@ "type": "set" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" - }, - {}, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "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", + "description": "True if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { "description": "Zone Token", @@ -49581,387 +49585,419 @@ "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" - }, - { - "description": "Zone description", - "name": "description", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "The first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "The guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, { "description": "The maximum value the MTU can have on the VR's private interfaces", "name": "routerprivateinterfacemaxmtu", "type": "integer" }, + {}, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "True, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" + "description": "True, if routed Network/VPC is enabled", + "name": "routedmodeenabled", + "type": "boolean" }, { - "description": "the capacity of the Zone", + "description": "The capacity of the Zone", "name": "capacity", "response": [ { - "description": "the total capacity available", + "description": "The Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "The total capacity available", "name": "capacitytotal", "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity currently in use", + "description": "The capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "The capacity type", + "name": "type", + "type": "short" }, { - "description": "the Zone name", + "description": "The Zone name", "name": "zonename", "type": "string" }, { - "description": "the capacity currently in allocated", + "description": "The capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", + "description": "The Pod name", "name": "podname", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", + "description": "The Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the percentage of capacity currently in use", + "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", - "type": "string" - }, - { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" - } - ] - }, - { - "description": "Extracts volume", - "isasync": true, - "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 ID of the volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" + "description": "The second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "The name of the containing domain, null for public zones", + "name": "domainname", "type": "string" - } - ], - "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", - "response": [ + }, { - "description": "the id of extracted object", - "name": "id", + "description": "The UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "the status of the extraction", - "name": "status", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "The display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "The DHCP Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "", - "name": "resultstring", + "description": "True, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + {}, + { + "description": "The type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "True if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "The first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "Network domain name for the Networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "The second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" } ] }, { - "description": "Lists IPv4 subnets for guest networks.", - "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", + "description": "Extracts volume", + "isasync": true, + "name": "extractVolume", "params": [ { - "description": "", + "description": "The ID of the zone where the volume is located", "length": 255, - "name": "pagesize", + "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": "integer" + "type": "string" }, { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": false, - "type": "uuid" + "name": "mode", + "required": true, + "type": "string" }, { - "description": "UUID of network to which the IPv4 subnet is associated to.", + "description": "The ID of the volume", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, "type": "uuid" + } + ], + "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", + "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": "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": "UUID of VPC to which the IPv4 subnet is associated to.", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "The Account ID to which the extracted object belongs", + "name": "accountid", + "type": "string" }, { - "description": "The CIDR of the Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "The time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "The mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "UUID of the IPv4 subnet for guest network.", - "length": 255, - "name": "id", - "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", - "required": false, - "type": "uuid" + "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "The name of the extracted object", + "name": "name", "type": "string" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "createIpv4SubnetForGuestNetwork", - "response": [ + "description": "Type of the storage", + "name": "storagetype", + "type": "string" + }, { - "description": "state of subnet of the IPv4 network", + "description": "The state of the extracted object", "name": "state", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", + "description": "Zone ID the object was extracted from", "name": "zoneid", "type": "string" }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "The upload ID of extracted object", + "name": "extractId", "type": "string" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "Zone name the object was extracted from", + "name": "zonename", "type": "string" }, + {}, + {}, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "The ID of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "The status of the extraction", + "name": "status", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "isasync": true, + "name": "releaseIpv4SubnetForZone", + "params": [ + { + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" }, {}, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, {}, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { @@ -49970,42 +50006,25 @@ "type": "date" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", - "type": "string" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.20.0" }, { - "description": "Lists project's accounts", + "description": "Lists project's Accounts", "isasync": false, "name": "listProjectAccounts", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list accounts of the project by project role id", + "description": "List Accounts of the project by project role id", "length": 255, "name": "projectroleid", "related": "listProjectRoles,updateProjectRole", @@ -50013,7 +50032,7 @@ "type": "uuid" }, { - "description": "list invitation by user ID", + "description": "List invitation by User ID", "length": 255, "name": "userid", "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", @@ -50021,24 +50040,30 @@ "type": "uuid" }, { - "description": "list accounts of the project by role", + "description": "List Accounts of the project by Account name", "length": 255, - "name": "role", + "name": "account", "required": false, "type": "string" }, { - "description": "ID of the project", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List Accounts of the project by role", + "length": 255, + "name": "role", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -50050,597 +50075,628 @@ "type": "string" }, { - "description": "list accounts of the project by account name", + "description": "ID of the project", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "related": "activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", - "type": "long" + "description": "The total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "The total number of Snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, + {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "The total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "The total number of Instances deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "The total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of networks available to be created for this project", + "description": "The total number of Networks available to be created for this project", "name": "networkavailable", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "The displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "The total number of Networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "The total number of VPCs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "The 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 project", - "name": "vmlimit", + "description": "The total number of public IP addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, - {}, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", - "type": "string" + "description": "The list of resource tags associated with Instance", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 total memory (in MB) the project can own", - "name": "memorylimit", + "description": "The total number of VPCs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "The total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "The total number of Instances running for this project", + "name": "vmrunning", + "type": "integer" }, + {}, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "The total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of 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 networks the project can own", - "name": "networklimit", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "The total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "The project Account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "The domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "The total number of Instances that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "type": "string" }, - {}, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "The total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "The date this project was created", + "name": "created", + "type": "date" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The domain ID the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "The total number of VPCs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "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 total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "The total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "The total number of CPU cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "The total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", - "type": "string" + "description": "The total number of CPU cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "The total number of Templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the total number of backups available to this project", + "name": "backupavailable", "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 backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "The total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "The total number of public IP addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "The total number of CPU cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the 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 list of resource tags associated with vm", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "The state of the project", + "name": "state", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "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", + "description": "The total number of Networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "The name of the project", + "name": "name", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "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 templates which have been created by this project", - "name": "templatetotal", + "description": "The total number of Snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the project", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ], "since": "3.0.0" }, { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "description": "Updates an existing autoscale policy.", "isasync": true, - "name": "releaseIpv4SubnetForZone", + "name": "updateAutoScalePolicy", "params": [ { - "description": "Id of the guest network IPv4 subnet", + "description": "The ID of the autoscale policy", "length": 255, "name": "id", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "uuid" - } - ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ + }, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "The list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "listConditions", + "required": false, + "type": "list" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "The name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "The cool down period in which the policy should not be evaluated after the action has been taken", + "length": 255, + "name": "quiettime", + "required": false, + "type": "integer" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "The duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + } + ], + "related": "listAutoScalePolicies", + "response": [ + { + "description": "The 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 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 project id of the IPv4 subnet", - "name": "projectid", + "description": "The domain name of the autoscale policy", + "name": "domain", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "Name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "The project id autoscale policy", + "name": "projectid", "type": "string" }, {}, { - "description": "the domain ID of the IPv4 subnet", + "description": "The domain ID of the autoscale policy", "name": "domainid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The autoscale policy ID", + "name": "id", + "type": "string" + }, + { + "description": "The list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" + }, + { + "description": "The duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" } - ], - "since": "4.20.0" + ] }, { - "description": "Updates an existing autoscale policy.", + "description": "Creates a IPv4 subnet for a zone.", "isasync": true, - "name": "updateAutoScalePolicy", + "name": "createIpv4SubnetForZone", "params": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "conditionids", - "related": "listConditions", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the autoscale policy", + "description": "UUID of the zone which the IPv4 subnet belongs to.", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "The CIDR of the IPv4 subnet.", "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, - "name": "quiettime", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "name", + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" } ], - "related": "listAutoScalePolicies", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, {}, { - "description": "the autoscale policy ID", - "name": "id", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "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 of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the domain name of the autoscale policy", + "description": "the domain name of the IPv4 subnet", "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": "name of the autoscale policy", - "name": "name", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" - }, - {} - ] + } + ], + "since": "4.20.0" }, { "description": "Creates a disk offering.", @@ -50648,73 +50704,72 @@ "name": "createDiskOffering", "params": [ { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": true, + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "disksize", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "Name of the disk offering", "length": 255, - "name": "provisioningtype", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "The storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "storagetype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "Whether disk offering IOPS is custom or not", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "customizediops", "required": false, - "since": "4.15", - "type": "uuid" + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", "length": 255, - "name": "bytesreadratemaxlength", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "Volumes using this offering should be encrypted", "length": 255, - "name": "bytesreadratemax", + "name": "encrypt", "required": false, - "type": "long" + "since": "4.18", + "type": "boolean" }, { - "description": "whether disk offering iops is custom or not", + "description": "Size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "customizediops", + "name": "disksize", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "Min IOPS of the disk offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "miniops", "required": false, - "type": "list" + "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "The ID of the containing zone(s), null for public offerings", "length": 255, "name": "zoneid", "related": "createZone,listZones,listZones", @@ -50723,153 +50778,154 @@ "type": "list" }, { - "description": "details to specify disk offering parameters", + "description": "Whether disk offering size is custom or not", "length": 255, - "name": "details", + "name": "customized", "required": false, - "since": "4.16", - "type": "map" + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", + "description": "Tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "Volumes using this offering should be encrypted", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "encrypt", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "I/O requests write rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopswriterate", "required": false, "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "storagetype", + "name": "provisioningtype", "required": false, "type": "string" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "Length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "Burst bytes write rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "Burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Details to specify disk offering parameters", "length": 255, - "name": "iopswriteratemax", + "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": "iopswriteratemaxlength", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "type": "integer" }, { - "description": "min iops of the disk offering", + "description": "Bytes read rate of the disk offering", "length": 255, - "name": "miniops", + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "I/O requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "iopsreadrate", "required": false, "type": "long" }, { - "description": "max iops of the disk offering", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "length": 255, - "name": "maxiops", + "name": "disksizestrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" }, { - "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": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", + "description": "Bytes write rate of the disk offering", "length": 255, - "name": "cachemode", + "name": "byteswriterate", "required": false, - "since": "4.14", - "type": "string" + "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "An optional field, whether to display the offering to the end user or not.", "length": 255, "name": "displayoffering", "required": false, "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "The ID of the containing domain(s), null for public offerings", "length": 255, - "name": "byteswriteratemaxlength", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "long" + "type": "list" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "disksizestrictness", + "name": "bytesreadratemaxlength", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "Max IOPS of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "whether disk offering size is custom or not", + "description": "Burst I/O requests write rate of the disk offering", "length": 255, - "name": "customized", + "name": "iopswriteratemax", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "Burst requests read rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "iopsreadratemax", "required": false, "type": "long" } @@ -50877,319 +50933,208 @@ "related": "", "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": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" - }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "Length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "state of the disk offering", + "name": "state", "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": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "The tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "Burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "The min IOPS of the disk offering", + "name": "miniops", "type": "long" }, {}, - {}, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "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 disk offering uses custom size, false otherwise", + "description": "True if disk offering uses custom size, false otherwise", "name": "iscustomized", "type": "boolean" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" - }, - { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "Unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "Bytes read rate of the disk offering", "name": "diskBytesReadRate", "type": "long" }, { - "description": "state of the disk offering", - "name": "state", - "type": "string" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", + "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "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": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "The storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "I/O requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "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": "the name of the disk offering", - "name": "name", - "type": "string" - }, - { - "description": "io requests read rate of the disk offering", + "description": "I/O requests read rate of the disk offering", "name": "diskIopsReadRate", "type": "long" }, + {}, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "True if disk offering uses custom IOPS, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "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": "Length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - } - ] - }, - { - "description": "Creates a IPv4 subnet for a zone.", - "isasync": true, - "name": "createIpv4SubnetForZone", - "params": [ - { - "description": "The CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "UUID of the zone which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "Burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "domain ID of the account owning the IPv4 subnet", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - } - ], - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ - { - "description": "the project name of the IPv4 subnet", - "name": "project", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "The name of the disk offering", + "name": "name", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "An alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "The vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "Additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The size of the disk offering in GB", + "name": "disksize", + "type": "long" }, - {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "Bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the account of the IPv4 subnet", - "name": "account", - "type": "string" + "description": "The date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" + "description": "Burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ], - "since": "4.20.0" + ] }, { "description": "Lists details of network protocols", @@ -51206,14 +51151,13 @@ ], "related": "", "response": [ - {}, { "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", "name": "index", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -51223,19 +51167,20 @@ "type": "string" }, { - "description": "the details of the protocol parameter", - "name": "details", - "type": "map" + "description": "the name of the protocol parameter", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the name of the protocol parameter", - "name": "name", - "type": "string" + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" }, {} ], @@ -51246,6 +51191,14 @@ "isasync": false, "name": "listLBHealthCheckPolicies", "params": [ + { + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -51254,11 +51207,13 @@ "type": "string" }, { - "description": "", + "description": "The ID of the health check policy", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "required": false, - "type": "integer" + "since": "4.4", + "type": "uuid" }, { "description": "", @@ -51268,50 +51223,55 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the health check policy", - "length": 255, - "name": "id", - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "since": "4.4", "type": "uuid" } ], "related": "createLBHealthCheckPolicy", "response": [ { - "description": "the list of healthcheckpolicies", + "description": "The ID of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "The list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the state of the policy", + "description": "The LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, + { + "description": "The state of the policy", "name": "state", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", + "description": "The description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "Number of consecutive health check failures before declaring an Instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { @@ -51320,95 +51280,80 @@ "type": "int" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "Number of consecutive health check success before declaring an Instance healthy", "name": "healthcheckthresshold", "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" } ], "type": "list" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "The domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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 id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "The Account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + {}, + { + "description": "The domain of the HealthCheck policy", + "name": "domain", "type": "string" } ], "since": "4.2.0" }, { - "description": "Attempts Migration of a VM with its volumes to a different host", + "description": "Attempts Migration of an Instance with its volumes to a different host", "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "description": "Destination Host ID to migrate Instance to.", "length": 255, - "name": "migrateto", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "migrateto", + "required": false, + "type": "map" }, { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "description": "Automatically select a destination host for a running Instance, if hostId is not specified. false by default", "length": 255, "name": "autoselect", "required": false, @@ -51416,650 +51361,564 @@ "type": "boolean" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "The ID of the Instance", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 description of the affinity group", - "name": "description", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - {}, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", + "description": "The vGPU type used by the Instance", "name": "vgpu", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", + "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 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 Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the account owning the security group", + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Account owning the security group", "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", + "description": "The list of Instance IDs associated with this Security Group", "name": "virtualmachineids", "type": "set" }, { - "description": "the project name of the group", + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The project name of the group", "name": "project", "type": "string" }, { - "description": "the list of egress rules associated with the security group", + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "security group name", + "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": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", "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 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", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", + "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", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", + "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", + "description": "Tag key name", "name": "key", "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the 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", + "description": "The name of the security group", "name": "name", "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { @@ -52068,118 +51927,234 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "ID of the VLAN/VNI if available", @@ -52187,399 +52162,374 @@ "type": "integer" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The gateway of the NIC", + "name": "gateway", + "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 isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the 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 if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", + "description": "ID of the VPC to which the NIC belongs", "name": "vpcid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "The 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 Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "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": "Guest vm Boot Type", - "name": "boottype", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, + {}, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The name of the Instance", + "name": "name", "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "OS name of the Instance", + "name": "osdisplayname", "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 ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "The project name of the Instance", + "name": "project", "type": "string" } ] @@ -52590,19 +52540,19 @@ "name": "listGuiThemes", "params": [ { - "description": "Whether to list removed themes.", + "description": "The ID of the domain to be filtered.", "length": 255, - "name": "showremoved", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The theme ID.", + "description": "Whether to list all themes.", "length": 255, - "name": "id", - "related": "listGuiThemes,createGuiTheme", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "Whether to only list the default theme.", @@ -52612,81 +52562,82 @@ "type": "boolean" }, { - "description": "The internet Common Name (CN) to be filtered.", + "description": "The theme ID.", "length": 255, - "name": "commonname", + "name": "id", + "related": "listGuiThemes,createGuiTheme", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Whether to list removed themes.", "length": 255, - "name": "page", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Whether to list public themes.", + "description": "List by keyword", "length": 255, - "name": "showpublic", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The name of the theme.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the domain to be filtered.", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The ID of the account to be filtered.", + "description": "The internet Common Name (CN) to be filtered.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "commonname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Whether to list all themes.", + "description": "Whether to list public themes.", "length": 255, - "name": "listall", + "name": "showpublic", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "The name of the theme.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "The ID of the account to be filtered.", "length": 255, - "name": "pagesize", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createGuiTheme", "response": [ { - "description": "ID of the custom GUI theme.", - "name": "id", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, + {}, { - "description": "Name of the GUI theme.", - "name": "name", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, { @@ -52699,57 +52650,56 @@ "name": "css", "type": "string" }, + {}, { "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", "name": "ispublic", "type": "boolean" }, - {}, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "domainids", - "type": "string" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", - "type": "boolean" + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" }, { - "description": "When the GUI theme was created.", - "name": "created", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "name": "commonnames", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", "type": "string" }, { - "description": "Description of the GUI theme.", - "name": "description", - "type": "string" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "accountids", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" } ], "since": "4.21.0.0" @@ -52760,45 +52710,46 @@ "name": "updateUser", "params": [ { - "description": "last name", + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", "length": 255, - "name": "lastname", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Last name", "length": 255, - "name": "timezone", + "name": "lastname", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "Email", "length": 255, - "name": "usersecretkey", + "name": "email", "required": false, "type": "string" }, { - "description": "first name", + "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": "firstname", + "name": "password", "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" }, @@ -52810,39 +52761,38 @@ "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Unique username", "length": 255, - "name": "userapikey", + "name": "username", "required": false, "type": "string" }, { - "description": "Unique username", + "description": "User uuid", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { - "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "apikeyaccess", + "name": "timezone", "required": false, - "since": "4.20.1.0", "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "First name", "length": 255, - "name": "mandate2fa", + "name": "firstname", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "password", + "name": "userapikey", "required": false, "type": "string" } @@ -52850,140 +52800,140 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the api key of the user", - "name": "apikey", + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" + }, + { + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, - {}, { - "description": "the 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 account ID of the user", - "name": "accountid", + "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 Account type of the user", + "name": "accounttype", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The user state", + "name": "state", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the role", + "description": "The user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "The ID of the role", "name": "roleid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "The domain name of the user", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "The user ID", + "name": "id", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "The boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, + {}, { - "description": "the user name", - "name": "username", + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "True if user is default, false otherwise", + "name": "isdefault", "type": "boolean" } ] @@ -52994,10 +52944,10 @@ "name": "removeCertFromLoadBalancer", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -53005,26 +52955,26 @@ "response": [ {}, { - "description": "true if operation is executed successfully", + "description": "The UUID of the latest async job acting on 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", + "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" - } + {} ] }, { @@ -53033,54 +52983,54 @@ "name": "addHost", "params": [ { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "the Pod ID for the host", + "description": "The Zone ID for the host", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the host URL", + "description": "The cluster name for the host", "length": 255, - "name": "url", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "hypervisor type of the host", + "description": "The username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "hypervisor", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "List of tags to be added to the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hosttags", "required": false, + "type": "list" + }, + { + "description": "The Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "the cluster name for the host", + "description": "Hypervisor type of the host", "length": 255, - "name": "clustername", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "The host URL, optionally add ssh port (format: 'host:port') for KVM hosts, otherwise falls back to the port defined at the config 'kvm.host.discovery.ssh.port'", "length": 255, - "name": "password", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -53091,14 +53041,6 @@ "since": "4.21.0", "type": "list" }, - { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, @@ -53115,71 +53057,27 @@ "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "The cluster ID for the host", "length": 255, - "name": "hosttags", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "The password for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "password", + "required": false, + "type": "string" } ], "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the name of the host", - "name": "name", - "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 after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" - }, - {}, - { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "comma-separated list of storage access groups for the host", @@ -53187,235 +53085,140 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "comma-separated list of tags for the host", + "description": "Comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "The host version", + "name": "version", "type": "string" }, - {}, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the outgoing network traffic on the host", + "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 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": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", + "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 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 average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "The state of the host", + "name": "state", + "type": "status" }, { - "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 date and time the host was created", - "name": "created", + "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 name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "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 HA information information", + "description": "The host HA information information", "name": "hostha", "type": "hostharesponse" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "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 amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "GPU cards present in the host", @@ -53427,9 +53230,19 @@ "type": "string" }, { - "description": "the list of enabled vGPUs", + "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", @@ -53441,8 +53254,8 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -53451,23 +53264,13 @@ "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 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": "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 Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", "type": "long" } ], @@ -53477,550 +53280,697 @@ "type": "list" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The host type", + "name": "type", + "type": "type" + }, + { + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "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", + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "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 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 name of the host", + "name": "name", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "The Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The ID of the host", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Attaches a disk volume to a virtual machine.", - "isasync": true, - "name": "attachVolume", - "params": [ + }, { - "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, + "description": "The CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "The last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "response": [ - { - "description": "size of the disk volume", - "name": "size", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "The last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "The admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, + } + ] + }, + { + "description": "Attaches a disk volume to an Instance.", + "isasync": true, + "name": "attachVolume", + "params": [ { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": " the ID of the Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, + "description": "The ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The project id of the VPN", + "name": "projectid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "pod id of the volume", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Pod id of the volume", "name": "podid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "The disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "Size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", + "description": "True if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "cluster id of the volume", + "description": "The date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "Cluster id of the volume", "name": "clusterid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the domain associated with the disk volume", + "description": "The domain associated with the disk volume", "name": "domain", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Type of the Instance", + "name": "vmtype", "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 chain info of the volume", - "name": "chaininfo", + "description": "Name of the disk offering", + "name": "diskofferingname", "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "The project name of the VPN", + "name": "project", + "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", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "Pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "bytes read rate of the disk volume", + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "Name of the Instance", + "name": "vmname", + "type": "string" + }, + { + "description": "Bytes read rate of the disk volume", "name": "diskBytesReadRate", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The status of the volume", + "name": "status", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" } ] @@ -54031,7 +53981,7 @@ "name": "deleteCniConfiguration", "params": [ { - "description": "the ID of the Userdata", + "description": "The ID of the Userdata", "length": 255, "name": "id", "related": "listCniConfiguration", @@ -54039,7 +53989,14 @@ "type": "uuid" }, { - "description": "an optional project for the userdata", + "description": "An optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "An optional project for the userdata", "length": 255, "name": "projectid", "related": "activateProject,createProject,suspendProject,updateProject", @@ -54047,44 +54004,37 @@ "type": "uuid" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" - }, - { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "True 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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.21.0" }, @@ -54094,15 +54044,7 @@ "name": "updateProject", "params": [ { - "description": "ID of the user to be promoted/demoted", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": false, - "type": "uuid" - }, - { - "description": "name of the project", + "description": "Name of the project", "length": 255, "name": "name", "required": false, @@ -54110,36 +54052,44 @@ "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" }, { - "description": "new Admin account for the project", + "description": "ID of the User to be promoted/demoted", "length": 255, - "name": "account", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "display text of the project", + "description": "ID of the project to be modified", "length": 255, - "name": "displaytext", + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "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 project to be modified", + "description": "New Admin Account for the project", "length": 255, - "name": "id", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "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, @@ -54149,358 +54099,338 @@ "related": "activateProject,createProject,suspendProject", "response": [ { - "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 memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the id of the project", - "name": "id", + "description": "The total number of CPU cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "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 project Account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "The total number of Networks the project can own", + "name": "networklimit", + "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "The total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "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 state of the project", - "name": "state", + "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", - "type": "long" + "description": "The total number of VPCs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "The total number of Instances 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 memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "The domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "The total number of Snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", - "type": "string" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "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 Instances deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "The domain ID the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "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 networks owned by project", - "name": "networktotal", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", - "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 number of CPU cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "The total number of Templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "The date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "The state of the project", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "The ID of the project", + "name": "id", "type": "string" }, { - "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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "The total number of VPCs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "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", + "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 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 memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "The total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", + "description": "The total number of Templates available to be created by this project", "name": "templateavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "The total number of Templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", - "type": "string" + "description": "The Account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "The total number of public IP addresses allocated for this project", + "name": "iptotal", + "type": "long" }, - {}, { "description": "the total number of backups available to this project", "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "The total 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 number of Networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of the project", + "description": "The name of the project", "name": "name", "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, + {}, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "The total number of public IP addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "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 virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "The total number of Networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", - "type": "long" + "description": "The list of resource tags associated with Instance", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "The displaytext of the project", + "name": "displaytext", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -54508,23 +54438,43 @@ "type": "resourceiconresponse" }, { - "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 volume being used by this project", - "name": "volumetotal", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "The total number of CPU cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "The total number of Instances running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "The total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "The total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" } ], @@ -54536,78 +54486,70 @@ "name": "listLoadBalancers", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the source IP address of the load balancer", + "description": "The source IP address of the load balancer", "length": 255, "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "the network ID of the load balancer", + "description": "The network ID of the source IP address", "length": 255, - "name": "networkid", + "name": "sourceipaddressnetworkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "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": "activateProject,createProject,suspendProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "scheme", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the name 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": "name", + "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 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 display flag; only ROOT admin is eligible to pass this parameter", + "description": "The scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "fordisplay", + "name": "scheme", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "List by keyword", @@ -54617,111 +54559,188 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The ID of the load balancer", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the load balancer", + "description": "The network ID of the load balancer", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the network ID of the source IP address", + "description": "The name of the load balancer", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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" } ], "related": "createLoadBalancer", "response": [ { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "Load Balancer source IP Network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "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 project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "The description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "The Account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", + "description": "The list of Instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "The IP address of the Instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The Instance ID", + "name": "id", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "Source port of the Load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "The state of the Load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "Instance port of the Load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "The list of resource tags associated with the Load Balancer", "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": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" } @@ -54729,126 +54748,57 @@ "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the account of the Load Balancer", - "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": "Load Balancer Network id", + "name": "networkid", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "The Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", "name": "algorithm", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "Load Balancer source ip", + "description": "Load Balancer source IP", "name": "sourceipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "The domain of the Load Balancer", + "name": "domain", + "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "The domain ID of the Load Balancer", + "name": "domainid", "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": "Is rule for display to the regular User", + "name": "fordisplay", + "type": "boolean" }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - } + {} ], "since": "4.2.0" }, @@ -54869,32 +54819,32 @@ "related": "getUserKeys", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The API key of the registered user", + "name": "apikey", "type": "string" }, {}, { - "description": "whether api key access is allowed or not", - "name": "apikeyaccess", - "type": "boolean" + "description": "The secret key of the registered user", + "name": "secretkey", + "type": "string" }, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "Whether API key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" }, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -54903,7 +54853,7 @@ "name": "deleteLBStickinessPolicy", "params": [ { - "description": "the ID of the LB stickiness policy", + "description": "The ID of the LB stickiness policy", "length": 255, "name": "id", "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", @@ -54913,56 +54863,57 @@ ], "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], "since": "3.0.0" }, { - "description": "Lists site to site vpn connection gateways", + "description": "Lists site to site VPN connection gateways", "isasync": false, "name": "listVpnConnections", "params": [ { - "description": "List by keyword", + "description": "ID of the VPN connection", "length": 255, - "name": "keyword", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "type": "string" + "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,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -54972,29 +54923,29 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "id of vpc", + "description": "ID of VPC", "length": 255, "name": "vpcid", "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", @@ -55002,196 +54953,195 @@ "type": "uuid" }, { - "description": "id of the vpn connection", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createVpnConnection,updateVpnConnection", "response": [ + {}, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "The connection ID", + "name": "id", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the date and time the host was removed", + "description": "The date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "the public IP address", - "name": "publicip", + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, - {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "The VPN gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "State of VPN connection", + "name": "passive", "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "description": "The domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", + "description": "If DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, { - "description": "the connection ID", - "name": "id", + "description": "The customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "The public IP address", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "The owner", + "name": "account", "type": "string" }, { - "description": "the project name", + "description": "The project name", "name": "project", "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 domain id of the owner", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "State of VPN connection", + "name": "state", "type": "string" }, { - "description": "is connection for display to the regular user", + "description": "Is connection for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "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": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "The project id", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "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": "State of vpn connection", - "name": "passive", + "description": "If Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" } ] }, { - "description": "remove Tungsten-Fabric policy", + "description": "Remove Tungsten-Fabric policy", "isasync": true, "name": "removeTungstenFabricPolicy", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", + "description": "The uuid of Tungsten-Fabric policy", "length": 255, "name": "policyuuid", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "The uuid of Tungsten-Fabric network", "length": 255, "name": "networkuuid", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones,listZones", @@ -55201,6 +55151,16 @@ ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "List Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "Tungsten-Fabric policy name", "name": "name", @@ -55211,31 +55171,21 @@ "name": "uuid", "type": "string" }, + {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -55247,105 +55197,105 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the image store provider name", + "description": "The URL for the image store", "length": 255, - "name": "provider", - "required": true, + "name": "url", + "required": false, "type": "string" }, { - "description": "the URL for the image store", + "description": "The name for the image store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "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 name for the image store", + "description": "The image store provider name", "length": 255, - "name": "name", - "required": false, + "name": "provider", + "required": true, "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ { - "description": "the Zone ID of the image store", + "description": "The scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "The Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "The name of the image store", + "name": "name", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Defines if store is read-only", + "name": "readonly", "type": "boolean" }, + {}, { - "description": "the 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 protocol of the image store", + "description": "The protocol of the image store", "name": "protocol", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "The ID of the image store", + "name": "id", + "type": "string" }, + {}, { - "description": "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 name of the image store", - "name": "name", + "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 name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "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 host's currently used disk size", + "description": "The host's currently used disk size", "name": "disksizeused", "type": "long" } @@ -55357,13 +55307,6 @@ "isasync": false, "name": "createASNRange", "params": [ - { - "description": "the end AS Number", - "length": 255, - "name": "endasn", - "required": true, - "type": "long" - }, { "description": "the start AS Number", "length": 255, @@ -55378,24 +55321,32 @@ "related": "createZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the end AS Number", + "length": 255, + "name": "endasn", + "required": true, + "type": "long" } ], "related": "listASNRanges", "response": [ - { - "description": "End AS Number", - "name": "endasn", - "type": "long" - }, { "description": "ID of the AS Number Range", "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Created date", + "name": "created", + "type": "date" + }, + { + "description": "End AS Number", + "name": "endasn", + "type": "long" }, { "description": "Zone ID", @@ -55403,27 +55354,26 @@ "type": "string" }, { - "description": "Start AS Number", - "name": "startasn", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Created date", - "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": "Start AS Number", + "name": "startasn", + "type": "long" + } ], "since": "4.20.0" }, { - "description": "add Tungsten-Fabric network gateway to logical router", + "description": "Add Tungsten-Fabric network gateway to logical router", "isasync": true, "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ @@ -55442,7 +55392,7 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones,listZones", @@ -55453,34 +55403,27 @@ "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "List Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -55488,59 +55431,60 @@ "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + {}, + {}, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" } ] }, { - "description": "list Tungsten-Fabric nic", + "description": "List Tungsten-Fabric nic", "isasync": false, "name": "listTungstenFabricNic", "params": [ { - "description": "", + "description": "The ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "The uuid of Tungsten-Fabric nic", "length": 255, "name": "nicuuid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric nic uuid", "name": "uuid", @@ -55551,21 +55495,27 @@ "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric nic 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric nic name", + "name": "name", + "type": "string" } ] }, @@ -55575,12 +55525,11 @@ "name": "listVmwareDcs", "params": [ { - "description": "Id of the CloudStack zone.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -55589,36 +55538,38 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, "name": "page", "required": false, "type": "integer" + }, + { + "description": "Id of the CloudStack zone.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "addVmwareDc", "response": [ + {}, { - "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 VMware vCenter name/ip", - "name": "vcenter", - "type": "string" + "description": "The Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { @@ -55627,82 +55578,81 @@ "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { - "description": "apply Tungsten-Fabric policy", + "description": "Apply Tungsten-Fabric policy", "isasync": true, "name": "applyTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "The UUID of network", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "networkuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of network", + "description": "The minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "networkuuid", + "name": "minorsequence", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "The UUID of Tungsten-Fabric policy", "length": 255, "name": "policyuuid", "required": true, "type": "string" }, { - "description": "the major sequence of Tungsten-Fabric policy", + "description": "The ID of zone", "length": 255, - "name": "majorsequence", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the minor sequence of Tungsten-Fabric policy", + "description": "The major sequence of Tungsten-Fabric policy", "length": 255, - "name": "minorsequence", + "name": "majorsequence", "required": true, "type": "integer" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "List Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -55712,16 +55662,16 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } ] }, { @@ -55730,129 +55680,199 @@ "name": "listZones", "params": [ { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "The ID of the domain associated with the zone", "length": 255, - "name": "networktype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the resource image for the zones", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the storage access group", "length": 255, - "name": "keyword", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the ID of the zone", + "description": "The Network type of the zone that the Instance belongs to", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "networktype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Flag to display the capacity of the zones", "length": 255, - "name": "page", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "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 Instance. Default is false.", "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", + "name": "available", "required": false, - "since": "4.19.0", - "type": "list" + "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "since": "4.3", - "type": "map" + "type": "integer" }, { - "description": "", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "list" }, { - "description": "the ID of the domain associated with the zone", + "description": "Flag to display the resource image for the zones", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the name of the storage access group", + "description": "List by keyword", "length": 255, - "name": "storageaccessgroup", + "name": "keyword", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "flag to display the capacity of the zones", + "description": "The name of the zone", "length": 255, - "name": "showcapacities", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "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 name of the zone", + "description": "The ID of the zone", "length": 255, - "name": "name", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createZone,listZones", "response": [ { - "description": "Zone name", - "name": "name", + "description": "The type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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" + }, + { + "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", + "type": "string" + }, + { + "description": "The first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" + }, + { + "description": "The allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Network domain name for the Networks in the zone", + "name": "domain", "type": "string" }, + { + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "True if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, { "description": "The maximum value the MTU can have on the VR's private interfaces", "name": "routerprivateinterfacemaxmtu", "type": "integer" }, + { + "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 UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { "description": "External network provider if any", @@ -55860,294 +55880,224 @@ "type": "string" }, { - "description": "the capacity of the Zone", + "description": "True, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + {}, + { + "description": "The name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "The DHCP Provider for the Zone", + "name": "dhcpprovider", + "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": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "The capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "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 name", - "name": "zonename", + "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 capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" - }, - { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" - }, - { - "description": "Zone Token", - "name": "zonetoken", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "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", + "description": "The second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "The second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "True, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone name", + "name": "name", "type": "string" }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "The guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "The first internal DNS for the Zone", "name": "internaldns1", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the list of resource tags associated with zone.", + "description": "The list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" - }, - {}, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", - "type": "string" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "True, if routed Network/VPC is enabled", + "name": "routedmodeenabled", "type": "boolean" } ] @@ -56182,61 +56132,61 @@ ], "related": "listQuarantinedIps,updateQuarantinedIp", "response": [ + {}, { - "description": "When the quarantine was created.", - "name": "created", + "description": "End date for the quarantine.", + "name": "enddate", "type": "date" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "When the quarantine was removed.", "name": "removed", "type": "date" }, - { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" - }, { "description": "ID of the account that removed the IP from quarantine.", "name": "removeraccountid", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "When the quarantine was created.", + "name": "created", "type": "date" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" } ], @@ -56248,17 +56198,17 @@ "name": "createExtension", "params": [ { - "description": "State of the extension", + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", "length": 255, - "name": "state", + "name": "orchestratorrequirespreparevm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Type of the extension", + "description": "Description of the extension", "length": 255, - "name": "type", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -56269,26 +56219,34 @@ "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "description": "State of the extension", "length": 255, - "name": "details", + "name": "state", "required": false, - "type": "map" + "type": "string" }, { - "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", "length": 255, - "name": "orchestratorrequirespreparevm", + "name": "reservedresourcedetails", "required": false, - "type": "boolean" + "since": "4.22.1", + "type": "string" }, { - "description": "Description of the extension", + "description": "Type of the extension", "length": 255, - "name": "description", - "required": false, + "name": "type", + "required": true, "type": "string" }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "Name of the extension", "length": 255, @@ -56300,110 +56258,115 @@ "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "response": [ { - "description": "Description of the extension", - "name": "description", + "description": "ID of the extension", + "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 extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "Name of the extension", - "name": "name", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, - {}, { "description": "The state of the extension", "name": "state", "type": "string" }, - { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" - }, - { - "description": "Type of the extension", - "name": "type", - "type": "string" - }, + {}, + {}, { "description": "The details of the extension", "name": "details", "type": "map" }, { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + }, {}, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "Name of the extension", + "name": "name", "type": "string" }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ { - "description": "ID of the resource associated with the extension", - "name": "id", - "type": "string" + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" }, { "description": "Name of the resource associated with this mapping", "name": "name", "type": "string" }, - { - "description": "Type of the resource", - "name": "type", - "type": "string" - }, { "description": "the details of the resource map", "name": "details", "type": "map" }, { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" } ], "type": "list" }, { - "description": "ID of the extension", - "name": "id", + "description": "Type of the extension", + "name": "type", "type": "string" }, - {}, { "description": "Removal timestamp of the extension, if applicable", "name": "removed", "type": "date" }, { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", + "type": "string" } ], "since": "4.21.0" }, { - "description": "Deletes the backup schedule of a VM", + "description": "Deletes the backup schedule of a Instance", "isasync": false, "name": "deleteBackupSchedule", "params": [ @@ -56411,7 +56374,7 @@ "description": "ID of the VM from which all backup schedules will be deleted.", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, @@ -56427,24 +56390,24 @@ ], "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", + "description": "The current status of the latest 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" } @@ -56457,11 +56420,12 @@ "name": "listBackupProviderOfferings", "params": [ { - "description": "", + "description": "The zone ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -56471,17 +56435,16 @@ "type": "string" }, { - "description": "The zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -56489,66 +56452,66 @@ "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", "response": [ { - "description": "name for the backup offering", + "description": "provider name", + "name": "provider", + "type": "string" + }, + { + "description": "Name for the backup offering", "name": "name", "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "Description for the backup offering", + "name": "description", "type": "string" }, - {}, - {}, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the date this backup offering was created", + "description": "The date this backup offering was created", "name": "created", "type": "date" }, + {}, { - "description": "description for the backup offering", - "name": "description", + "description": "External ID on the provider side", + "name": "externalid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the backups with this offering can be used to create Instances on all Zones", "name": "crosszoneinstancecreation", "type": "boolean" }, + {}, + { + "description": "Zone name", + "name": "zonename", + "type": "string" + }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", + "description": "Whether the offering allows User driven ad-hoc/scheduled backups", "name": "allowuserdrivenbackups", "type": "boolean" }, { - "description": "provider name", - "name": "provider", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone ID", - "name": "zoneid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the backup offering", "name": "id", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.14.0" @@ -56559,7 +56522,7 @@ "name": "releasePublicIpRange", "params": [ { - "description": "the id of the Public IP range", + "description": "The ID of the Public IP range", "length": 255, "name": "id", "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", @@ -56569,47 +56532,48 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "True 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", + "description": "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, {} ] }, { - "description": "lists network that are using a netscaler load balancer device", + "description": "Lists network that are using a netscaler load balancer device", "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "Netscaler load balancer device ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -56619,550 +56583,549 @@ "type": "string" }, { - "description": "netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "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": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "The capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The service provider name", + "name": "provider", + "response": [ + { + "description": "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 provider name", + "name": "name", + "type": "string" + }, + { + "description": "State of the Network provider", + "name": "state", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "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": "List Networks available for Instance deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "VPC the Network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "The Network's IP range not to be used by CloudStack guest Instances 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": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, - {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "The project ID of the IP address", + "name": "projectid", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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", + "description": "True if Network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "State of the Network", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The domain ID of the Network owner", + "name": "domainid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "related to what other network configuration", + "description": "Related to what other Network configuration", "name": "related", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The external ID of the Network", + "name": "externalid", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "True if Network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "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 traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "ACL type - access type to the Network", + "name": "acltype", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The ID of the Network", + "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "True if Network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "List Networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "ACL name associated with the VPC Network", + "name": "aclname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "The displaytext of the Network", + "name": "displaytext", "type": "string" }, { - "description": "ACL Id associated with the VPC network", + "description": "ACL ID associated with the VPC Network", "name": "aclid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "The date this Network was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "availability of the network offering the network is created from", + "description": "Availability of the Network offering the Network is created from", "name": "networkofferingavailability", "type": "string" }, { - "description": "the first IPv4 DNS for the network", + "description": "The first IPv4 DNS for the Network", "name": "dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The second IPv4 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": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "True if Network supports specifying IP ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "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 domain id of the network owner", - "name": "domainid", + "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 owner of the network", - "name": "account", + "description": "The name of the Network", + "name": "name", "type": "string" }, - {}, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Network offering ID the Network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "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": "Tag value", + "name": "value", "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 domain associated with the tag", + "name": "domain", + "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": "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 physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The name of the zone the Network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "The type of the Network", + "name": "type", "type": "string" - } + }, + { + "description": "The details of the Network", + "name": "details", + "type": "map" + }, + { + "description": "The Network's netmask", + "name": "netmask", + "type": "string" + }, + {} ] }, { - "description": "create Tungsten-Fabric public network", + "description": "Create Tungsten-Fabric public network", "isasync": false, "name": "createTungstenFabricPublicNetwork", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones", @@ -57171,78 +57134,29 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Lists supported methods of network isolation", - "isasync": false, - "name": "listNetworkIsolationMethods", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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", + "description": "Any text associated with the 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": "Network isolation method name", - "name": "name", - "type": "string" - } - ], - "since": "4.2.0" + {} + ] }, { "description": "Lists host HA resources", @@ -57260,40 +57174,40 @@ ], "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ - {}, { - "description": "if host HA is enabled for the host", + "description": "If host HA is enabled for the host", "name": "haenable", "type": "boolean" }, { - "description": "the HA state of the host", + "description": "The HA state of the host", "name": "hastate", "type": "hastate" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "operation status", + "description": "Operation status", "name": "status", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The host HA provider", + "name": "haprovider", "type": "string" }, {} @@ -57301,23 +57215,65 @@ "since": "4.11" }, { - "description": "list Tungsten-Fabric firewall policy", + "description": "Lists supported methods of network isolation", "isasync": false, - "name": "listTungstenFabricFirewallPolicy", + "name": "listNetworkIsolationMethods", "params": [ { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "List by keyword", "length": 255, - "name": "firewallpolicyuuid", + "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": "Network isolation method name", + "name": "name", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ], + "since": "4.2.0" + }, + { + "description": "List Tungsten-Fabric firewall policy", + "isasync": false, + "name": "listTungstenFabricFirewallPolicy", + "params": [ + { + "description": "The UUID of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, + "type": "string" }, { "description": "", @@ -57327,7 +57283,14 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "The UUID of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones", @@ -57335,59 +57298,59 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "List by keyword", "length": 255, - "name": "applicationpolicysetuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "createTungstenFabricFirewallPolicy", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, + {}, { "description": "Tungsten-Fabric firewall policy uuid", "name": "uuid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "Tungsten-Fabric firewall policy name", "name": "name", "type": "string" }, - {} + {}, + { + "description": "List Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -57396,38 +57359,38 @@ "name": "importBackupOffering", "params": [ { - "description": "The backup offering ID (from backup provider side)", + "description": "The name of the backup offering", "length": 255, - "name": "externalid", + "name": "name", "required": true, "type": "string" }, { - "description": "Whether users are allowed to create adhoc backups and backup schedules", + "description": "The zone ID", "length": 255, - "name": "allowuserdrivenbackups", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "boolean" + "type": "uuid" }, { - "description": "the description of the backup offering", + "description": "Whether users are allowed to create adhoc backups and backup schedules", "length": 255, - "name": "description", + "name": "allowuserdrivenbackups", "required": true, - "type": "string" + "type": "boolean" }, { - "description": "The zone ID", + "description": "The backup offering ID (from backup provider side)", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "externalid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the name of the backup offering", + "description": "The description of the backup offering", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" } @@ -57435,65 +57398,65 @@ "related": "listBackupOfferings,updateBackupOffering", "response": [ { - "description": "the backups with this offering can be used to create Instances on all Zones", - "name": "crosszoneinstancecreation", - "type": "boolean" + "description": "Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description for the backup offering", + "name": "description", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "name for the backup offering", - "name": "name", + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + { + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "Zone name", + "name": "zonename", "type": "string" }, { - "description": "the date this backup offering was created", + "description": "The date this backup offering was created", "name": "created", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", + "description": "Whether the offering allows User driven ad-hoc/scheduled backups", "name": "allowuserdrivenbackups", "type": "boolean" }, + {}, { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the backup offering", - "name": "id", + "description": "External ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "provider name", - "name": "provider", + "description": "Name for the backup offering", + "name": "name", "type": "string" }, {}, { - "description": "zone name", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -57504,13 +57467,6 @@ "isasync": true, "name": "deleteDomain", "params": [ - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, { "description": "ID of domain to delete", "length": 255, @@ -57518,28 +57474,35 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" } @@ -57551,17 +57514,10 @@ "name": "migrateVolume", "params": [ { - "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", + "description": "The ID of the volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, @@ -57574,161 +57530,101 @@ "type": "uuid" }, { - "description": "the ID of the volume", + "description": "If the volume should be live migrated when it is attached to a running Instance", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "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,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - {}, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "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", + "name": "jobstatus", + "type": "integer" }, { - "description": "pod id of the volume", + "description": "Pod id of the volume", "name": "podid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "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", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the date the volume was attached to a VM instance", + "description": "The date the volume was attached to an Instance", "name": "attached", "type": "date" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "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": "name", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "cluster id of the volume", + "description": "Cluster id of the volume", "name": "clusterid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "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" }, { @@ -57737,404 +57633,545 @@ "type": "long" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "True if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "pod name of the volume", + "description": "Pod name of the volume", "name": "podname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 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": "Tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "size of the disk volume", + "description": "Size of the disk volume", "name": "size", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "The date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "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", + "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": "The state of the disk volume", + "name": "state", + "type": "string" }, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Name of the disk offering", + "name": "diskofferingname", + "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": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "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": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "create Tungsten-Fabric application policy set", - "isasync": true, - "name": "createTungstenFabricApplicationPolicySet", - "params": [ + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the 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": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {} - ] + "description": "The path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "Name of the Instance", + "name": "vmname", + "type": "string" + }, + { + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + } + ], + "since": "3.0.0" }, { - "description": "A command to list events.", - "isasync": false, - "name": "listEvents", + "description": "Create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", "params": [ { - "description": "the type of the resource associated with the event", + "description": "The ID of zone", "length": 255, - "name": "resourcetype", - "required": false, - "since": "4.17.0", - "type": "string" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Tungsten-Fabric application policy set name", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "List Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the time the event was entered", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "List Tungsten-Fabric tag", + "name": "tag", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", "length": 255, - "name": "entrytime", - "required": false, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "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": "", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ + { + "description": "Hypervisor type of the resource", "length": 255, - "name": "page", - "required": false, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost", + "response": [ + {}, + { + "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": "The host HA provider", + "name": "haprovider", + "type": "string" + }, + {}, + { + "description": "Operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the host", + "name": "hostid", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "True to list archived events otherwise false", "length": 255, - "name": "isrecursive", + "name": "archived", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "startid", + "related": "listEvents", "required": false, "type": "uuid" }, + { + "description": "The type of the resource associated with the event", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.17.0", + "type": "string" + }, { "description": "The state of the events", "length": 255, @@ -58144,160 +58181,140 @@ "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": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "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 event type (see event types)", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "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": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "true to list archived events otherwise false", + "description": "The ID of the event", "length": 255, - "name": "archived", + "name": "id", + "related": "listEvents", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the resource associated with the event", + "description": "The time the event was entered", "length": 255, - "name": "resourceid", + "name": "entrytime", "required": false, - "since": "4.17.0", - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "The duration of the event", "length": 255, - "name": "enddate", + "name": "duration", "required": false, - "type": "date" + "type": "integer" }, { - "description": "List by keyword", + "description": "The event type (see event types)", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "The event level (INFO, WARN, ERROR)", "length": 255, "name": "level", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the resource", - "name": "resourcename", - "type": "string" }, { - "description": "the date the event was created", - "name": "created", + "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": "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", - "type": "string" - }, - { - "description": "the ID of the event", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the state of the event", - "name": "state", - "type": "state" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "The ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.0", "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the id of the resource", - "name": "resourceid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "The Account name for the Account that owns the object being acted on in the event (e.g. the owner of the Instance, IP address, or security group)", + "name": "account", "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": "a brief description of the event", - "name": "description", + "description": "Whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The ID of the resource", + "name": "resourceid", "type": "string" }, { @@ -58306,132 +58323,78 @@ "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "The ID of the event", + "name": "id", "type": "string" }, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "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 Instance)", "name": "username", "type": "string" }, - { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" - }, {}, { - "description": "the type of the event (see event types)", - "name": "type", - "type": "string" - }, - { - "description": "the type of the resource", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the id of the account's domain", + "description": "The ID of the Account's domain", "name": "domainid", "type": "string" - } - ] - }, - { - "description": "Deletes an existing Bgp Peer.", - "isasync": true, - "name": "deleteBgpPeer", - "params": [ - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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 Account's domain", + "name": "domain", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The state of the event", + "name": "state", + "type": "state" }, - {}, - {} - ], - "since": "4.20.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,enableHAForHost,disableHAForHost", - "response": [ { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "Whether the event has been archived or not", + "name": "archived", + "type": "boolean" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "The type of the event (see event types)", + "name": "type", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the resource", + "name": "resourcename", "type": "string" }, {}, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "The date the event was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "A brief description of the event", + "name": "description", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "The project ID of the IP address", + "name": "projectid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The type of the resource", + "name": "resourcetype", + "type": "string" } - ], - "since": "4.11" + ] }, { "description": "Creates resource tag(s)", @@ -58439,28 +58402,28 @@ "name": "createTags", "params": [ { - "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" }, { - "description": "type of the resource", + "description": "Type of the resource", "length": 255, "name": "resourcetype", "required": true, "type": "string" }, { - "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", + "description": "Identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, "name": "customer", "required": false, @@ -58469,26 +58432,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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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.0.0" @@ -58499,7 +58462,7 @@ "name": "createInternalLoadBalancerElement", "params": [ { - "description": "the network service provider ID of the internal load balancer element", + "description": "The network service provider ID of the internal load balancer element", "length": 255, "name": "nspid", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", @@ -58509,25 +58472,18 @@ ], "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ - {}, - {}, { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, - { - "description": "the physical network service provider id of the element", + "description": "The physical Network service provider ID of the element", "name": "nspid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the internal Load balancer element", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -58535,6 +58491,13 @@ "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" } ], "since": "4.2.0" @@ -58545,7 +58508,7 @@ "name": "resetApiLimit", "params": [ { - "description": "the ID of the account whose limit to be reset", + "description": "The ID of the Account whose limit to be reset", "length": 255, "name": "account", "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", @@ -58554,28 +58517,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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" + }, + {} ] }, { @@ -58584,7 +58547,7 @@ "name": "deleteVlanIpRange", "params": [ { - "description": "the id of the VLAN IP range", + "description": "The ID of the VLAN IP range", "length": 255, "name": "id", "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", @@ -58594,23 +58557,23 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -58623,18 +58586,12 @@ "name": "generateAlert", "params": [ { - "description": "Type of the alert", + "description": "Pod id for which alert is generated", "length": 255, - "name": "type", - "required": true, - "type": "short" - }, - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { "description": "Zone id for which alert is generated", @@ -58645,12 +58602,11 @@ "type": "uuid" }, { - "description": "Pod id for which alert is generated", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" }, { "description": "Name of the alert", @@ -58658,30 +58614,37 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "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", + "description": "Any text associated with the 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.3" @@ -58692,11 +58655,11 @@ "name": "ldapConfig", "params": [ { - "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 path to trust certificates store.", @@ -58706,32 +58669,32 @@ "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "queryfilter", + "name": "hostname", "required": false, "type": "string" }, { - "description": "Enter the password for trust store.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "truststorepass", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "searchbase", + "name": "binddn", "required": false, "type": "string" }, { - "description": "If true return current LDAP configuration", + "description": "Enter the password.", "length": 255, - "name": "listall", + "name": "bindpass", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Specify the LDAP port if required, default is 389.", @@ -58741,52 +58704,54 @@ "type": "integer" }, { - "description": "Enter the password.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "bindpass", + "name": "searchbase", "required": false, "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "If true return current LDAP configuration", "length": 255, - "name": "binddn", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Enter the password for trust store.", "length": 255, - "name": "ssl", + "name": "truststorepass", "required": false, - "type": "boolean" + "type": "string" } ], "related": "ldapRemove", "response": [ { - "description": "DN password", - "name": "bindpass", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "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": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58795,22 +58760,20 @@ "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "DN password", + "name": "bindpass", "type": "string" }, - {}, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", "name": "searchbase", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" + } ], "since": "3.0.0" }, @@ -58830,43 +58793,43 @@ ], "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the Storage Policy", + "name": "id", + "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "The name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "The ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "The identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The description of the Storage Policy", + "name": "description", "type": "string" - } + }, + {} ] }, { @@ -58875,10 +58838,10 @@ "name": "deletePortForwardingRule", "params": [ { - "description": "the ID of the port forwarding rule", + "description": "The ID of the port forwarding rule", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -58886,35 +58849,42 @@ "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 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", + "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": "moves a vpc to another physical network", + "description": "Moves a VPC to another physical network", "isasync": true, "name": "migrateVPC", "params": [ { - "description": "the ID of the vpc", + "description": "Network offering IDs for each network in the VPC. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, + { + "description": "The ID of the VPC ", "length": 255, "name": "vpcid", "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", @@ -58922,33 +58892,92 @@ "type": "uuid" }, { - "description": "true if previous network migration cmd failed", + "description": "True if previous network migration cmd failed", "length": 255, "name": "resume", "required": false, "type": "boolean" }, { - "description": "vpc offering ID", + "description": "VPC offering ID", "length": 255, "name": "vpcofferingid", "related": "updateVPCOffering,listVPCOfferings", "required": true, "type": "uuid" - }, - { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC", "response": [ { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "Does VPC use distributed router for one hop forwarding and host based Network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "The first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "If this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "The date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "The domain name of the owner", + "name": "domain", + "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 owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "The project ID of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The list of Networks belonging to the VPC", + "name": "network", + "type": "list" + }, + { + "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", "type": "string" }, { @@ -58957,73 +58986,73 @@ "type": "string" }, { - "description": "the list of supported services", + "description": "The list of supported services", "name": "service", "response": [ { - "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": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "State of the Network provider", + "name": "state", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "UUID of the Network provider", + "name": "id", + "type": "string" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" }, { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "The list of capabilities", + "name": "capability", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The capability value", + "name": "value", "type": "string" }, { - "description": "the provider name", + "description": "The capability name", "name": "name", "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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", "type": "boolean" } ], @@ -59032,249 +59061,183 @@ ], "type": "list" }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, { "description": "MTU configured on the public interfaces of the VPC VR", "name": "publicmtu", "type": "integer" }, - {}, { - "description": "the id of the VPC", + "description": "The ID of the VPC", "name": "id", "type": "string" }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, {}, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "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": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Is VPC for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "The CIDR the VPC", + "name": "cidr", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "true VPC requires restart", + "description": "True VPC requires restart", "name": "restartrequired", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with the project", + "description": "The list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", + "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": "tag key name", - "name": "key", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the network domain of the VPC", + "description": "State of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "VPC offering ID the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "The Network domain of the VPC", "name": "networkdomain", "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 second IPv4 DNS for the VPC", - "name": "dns2", + "description": "The first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "an alternate display text of the VPC.", + "description": "An alternate display text of the VPC.", "name": "displaytext", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "The project name of the VPC", + "name": "project", "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "The second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "The name of the VPC", + "name": "name", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "The name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "Zone ID of the VPC", + "name": "zoneid", + "type": "string" + }, + { + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" } ], "since": "4.11.0" @@ -59285,7 +59248,7 @@ "name": "deleteGlobalLoadBalancerRule", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "The ID of the global load balancer rule", "length": 255, "name": "id", "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", @@ -59295,337 +59258,337 @@ ], "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": "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": "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": "update an annotation visibility.", + "description": "Update an annotation visibility.", "isasync": false, "name": "updateAnnotationVisibility", "params": [ { - "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" }, { - "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" } ], "related": "addAnnotation,listAnnotations,removeAnnotation", "response": [ { - "description": "the contents of the annotation", + "description": "The contents of the annotation", "name": "annotation", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - {}, - { - "description": "the removal timestamp for this annotation", + "description": "The removal timestamp for this annotation", "name": "removed", "type": "date" }, + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "The type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the annotation", + "name": "id", + "type": "string" }, - {}, { - "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 username of the user that entered the annotation", - "name": "username", + "description": "The name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "The UUID of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "The creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "The UUID of the User that entered the annotation", + "name": "userid", "type": "string" } ], "since": "4.16" }, { - "description": "Updates a configuration.", - "isasync": false, - "name": "updateConfiguration", + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the configuration", + "description": "HA provider", "length": 255, - "name": "name", + "name": "provider", "required": true, "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "ID of the host", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, "type": "uuid" + } + ], + "related": "enableHAForHost,disableHAForHost", + "response": [ + { + "description": "Operation status", + "name": "status", + "type": "boolean" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "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": "The ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "The host HA provider", + "name": "haprovider", + "type": "string" + }, + {}, + { + "description": "If host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + {} + ], + "since": "4.11" + }, + { + "description": "Updates a configuration.", + "isasync": false, + "name": "updateConfiguration", + "params": [ + { + "description": "The ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the value of the configuration", + "description": "The value of the configuration", "length": 4096, "name": "value", "required": false, "type": "string" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "The ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "The ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" - } - ], - "related": "listConfigurations", - "response": [ - { - "description": "the possible options of the configuration value", - "name": "options", - "type": "string" - }, - { - "description": "the group of the configuration", - "name": "group", - "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "The name of the configuration", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "required": false, + "type": "uuid" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "The ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the category of the configuration", - "name": "category", - "type": "string" - }, - {}, + "description": "The ID of the Cluster to update the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + } + ], + "related": "listConfigurations", + "response": [ { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "The type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the type of the configuration value", - "name": "type", + "description": "The possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "The category of the configuration", + "name": "category", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "The default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "The value of the configuration", + "name": "value", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", - "type": "string" + "description": "True if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the value of the configuration", - "name": "value", + "description": "The group of the configuration", + "name": "group", "type": "string" }, { - "description": "the component of the configuration", + "description": "The component of the configuration", "name": "component", "type": "string" }, + {}, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" - } - ] - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "enableHAForHost,disableHAForHost", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The display text of the configuration", + "name": "displaytext", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "Scope (zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" }, {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "The value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The description of the configuration", + "name": "description", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "The name of the parent configuration", + "name": "parent", + "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "The subgroup of the configuration", + "name": "subgroup", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the configuration", + "name": "name", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "Lists volume stats", @@ -59633,32 +59596,32 @@ "name": "listVolumesUsageHistory", "params": [ { - "description": "", + "description": "End date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "", + "description": "the IDs of the Volumes, mutually exclusive with id.", "length": 255, - "name": "page", + "name": "ids", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the IDs of the volumes, mutually exclusive with id.", + "description": "", "length": 255, - "name": "ids", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ID of the volume.", + "description": "The ID of the volume.", "length": 255, "name": "id", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, @@ -59670,56 +59633,56 @@ "type": "string" }, { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", + "description": "Name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" } ], "related": "", "response": [ + {}, { - "description": "the name of the volume", + "description": "The name of the volume", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the list of VM stats", + "description": "The list of VM stats", "name": "stats", "type": "list" }, + {}, { - "description": "the ID of the volume", + "description": "The ID of the volume", "name": "id", "type": "string" - }, - {}, - {} + } ], "since": "4.18.0" }, @@ -59729,15 +59692,15 @@ "name": "dedicatePublicIpRange", "params": [ { - "description": "project who will own the VLAN", + "description": "Domain ID of the account owning a VLAN", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, "type": "uuid" }, { - "description": "the id of the VLAN IP range", + "description": "The ID of the VLAN IP range", "length": 255, "name": "id", "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", @@ -59745,15 +59708,15 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "Project who will own the VLAN", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, "type": "uuid" }, { - "description": "account who will own the VLAN", + "description": "Account who will own the VLAN", "length": 255, "name": "account", "required": false, @@ -59763,194 +59726,175 @@ "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "The Network ID of VLAN range", + "name": "networkid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", + "description": "The Pod name for the VLAN IP range", "name": "podname", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "The Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "The project ID of the VLAN range", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "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" }, { - "description": "the description of the VLAN IP range", - "name": "description", - "type": "string" + "description": "Indicates whether VLAN IP range is dedicated to System VMs or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "The virtual Network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, - {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The end IP of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The start IPv6 of the VLAN IP range", + "name": "startipv6", "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 domain ID of the VLAN IP range", - "name": "domainid", + "description": "The domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "The Account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "The domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The end IPv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, + {}, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "The gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the project name of the vlan range", + "description": "The project name of the VLAN range", "name": "project", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "The ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "Path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "The Zone ID of the VLAN IP range", "name": "zoneid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "The CIDR of the VLAN IP range", + "name": "cidr", "type": "string" } ] }, { - "description": "Deletes an empty Bucket.", + "description": "Adds API permissions to a project role", "isasync": false, - "name": "deleteBucket", + "name": "createProjectRolePermission", "params": [ { - "description": "The ID of the Bucket", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "id", - "related": "createBucket,listBuckets", + "name": "rule", "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Adds API permissions to a project role", - "isasync": false, - "name": "createProjectRolePermission", - "params": [ { "description": "ID of project where project role permission is to be created", "length": 255, @@ -59966,136 +59910,155 @@ "related": "listProjectRoles,updateProjectRole", "required": true, "type": "uuid" - }, + } + ], + "related": "listProjectRolePermissions", + "response": [ { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, + "description": "The description of the role permission", + "name": "description", "type": "string" }, { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, + "description": "The ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, + "description": "The ID of the project role permission", + "name": "id", "type": "string" - } - ], - "related": "listProjectRolePermissions", - "response": [ - {}, + }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "The api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the project", - "name": "projectid", + "description": "The 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", + "description": "The permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Deletes an empty Bucket.", + "isasync": false, + "name": "deleteBucket", + "params": [ + { + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "createBucket,listBuckets", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "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": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the description of the role permission", - "name": "description", + "description": "Any text associated with the success or failure", + "name": "displaytext", "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" } ], - "since": "4.15.0" + "since": "4.19.0" }, { - "description": "Create a console endpoint to connect to a VM console", + "description": "Create a console endpoint to connect to a Instance console", "isasync": false, "name": "createConsoleEndpoint", "params": [ + { + "description": "ID of the Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, "name": "token", "required": false, "type": "string" - }, - { - "description": "ID of the VM", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "details in case of an error", - "name": "details", - "type": "string" + "description": "True if the console endpoint is generated properly", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the console url", - "name": "url", + "description": "Details in case of an error", + "name": "details", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "true if the console endpoint is generated properly", - "name": "success", - "type": "boolean" + "description": "The console url", + "name": "url", + "type": "string" }, { - "description": "the console websocket options", + "description": "The console websocket options", "name": "websocket", "type": "consoleendpointwebsocketresponse" - } + }, + {} ], "since": "4.18.0" }, @@ -60105,7 +60068,15 @@ "name": "updateProjectRolePermission", "params": [ { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "ID of project where project role permission is to be updated", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the parent role permission, use 0 to move this rule at the top of the list", "length": 255, "name": "ruleorder", "related": "listProjectRolePermissions", @@ -60127,14 +60098,6 @@ "required": true, "type": "uuid" }, - { - "description": "ID of project where project role permission is to be updated", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, - "type": "uuid" - }, { "description": "Project Role permission rule id", "length": 255, @@ -60146,32 +60109,32 @@ ], "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "4.15.0" }, { - "description": "Adds user to a project", + "description": "Adds User to a project", "isasync": true, "name": "addUserToProject", "params": [ @@ -60184,7 +60147,14 @@ "type": "uuid" }, { - "description": "ID of the project to add the user to", + "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, "name": "projectid", "related": "activateProject,createProject,suspendProject", @@ -60192,21 +60162,14 @@ "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular", + "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, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "Email ID of User to which invitation to the project is going to be sent", "length": 255, "name": "email", "required": false, @@ -60214,27 +60177,27 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "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" } ], "since": "4.14" @@ -60256,23 +60219,23 @@ "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -60280,532 +60243,161 @@ "since": "4.11" }, { - "description": "delete Tungsten-Fabric firewall policy", + "description": "Delete Tungsten-Fabric firewall policy", "isasync": true, "name": "deleteTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", + "description": "The uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "firewallpolicyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "The ID of zone", "length": 255, - "name": "firewallpolicyuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on 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": "Recovers a virtual machine.", + "description": "Recovers an Instance.", "isasync": false, "name": "recoverVirtualMachine", "params": [ { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "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 name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag 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" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the 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": "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project 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": "id of the resource", - "name": "resourceid", - "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "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", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { @@ -60814,52 +60406,32 @@ "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", + "description": "The ID of the corresponding Network", "name": "networkid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -60868,578 +60440,989 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", + "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" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The type of the NIC", + "name": "type", "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": "isdefault", - "type": "boolean" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", + "description": "Public IP address ID associated with this NIC via Static NAT rule", "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The gateway of the NIC", + "name": "gateway", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "true if nic is default, false otherwise", + "description": "True if NIC is default, false otherwise", "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" } ], "type": "set" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "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 name of userdata used for the VM", - "name": "userdataname", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + {}, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The 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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + {}, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project ID of the affinity group", + "description": "The project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "The domain ID of the affinity group", "name": "domainid", "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 domain name of the affinity group", - "name": "domain", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The account owning the affinity group", + "name": "account", + "type": "string" }, { - "description": "the ID of the affinity group", + "description": "The ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the video RAM size in MB", + "name": "videoram", "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", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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 read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "The memory allocated for the Instance", + "name": "memory", "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "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": "OS type id of the vm", - "name": "ostypeid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { @@ -61448,64 +61431,49 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" } ] }, { - "description": "Resets network permissions.", + "description": "Resets Network permissions.", "isasync": false, "name": "resetNetworkPermissions", "params": [ { - "description": "the network ID", + "description": "The Network ID", "length": 255, "name": "networkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", @@ -61514,27 +61482,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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.17.0" @@ -61544,6 +61512,13 @@ "isasync": true, "name": "updateBgpPeer", "params": [ + { + "description": "BGP peer details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "Id of the Bgp Peer", "length": 255, @@ -61560,11 +61535,18 @@ "type": "string" }, { - "description": "BGP peer details in key/value pairs.", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "details", + "name": "asnumber", "required": false, - "type": "map" + "type": "long" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { "description": "The password of the Bgp Peer.", @@ -61579,194 +61561,180 @@ "name": "ipaddress", "required": false, "type": "string" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "The AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" } ], "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, { "description": "the domain ID of the bgp peer", "name": "domainid", "type": "string" }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, - {} + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + } ], "since": "4.20.0" }, { - "description": "update Tungsten-Fabric loadbalancer health monitor", + "description": "Update Tungsten-Fabric loadbalancer health monitor", "isasync": true, "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "loadbalancer health monitor expected code", - "length": 255, - "name": "expectedcode", - "required": false, - "type": "string" - }, - { - "description": "the ID of lb rule", + "description": "Loadbalancer health monitor retry", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "retry", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "loadbalancer health monitor interval", + "description": "Loadbalancer health monitor type", "length": 255, - "name": "interval", + "name": "type", "required": true, - "type": "integer" + "type": "string" }, { - "description": "loadbalancer health monitor retry", + "description": "Loadbalancer health monitor HTTP method", "length": 255, - "name": "retry", - "required": true, - "type": "integer" + "name": "httpmethodtype", + "required": false, + "type": "string" }, { - "description": "loadbalancer health monitor timeout", + "description": "Loadbalancer health monitor interval", "length": 255, - "name": "timeout", + "name": "interval", "required": true, "type": "integer" }, { - "description": "loadbalancer health monitor type", + "description": "Loadbalancer health monitor expected code", "length": 255, - "name": "type", - "required": true, + "name": "expectedcode", + "required": false, "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "Loadbalancer health monitor URL path", "length": 255, - "name": "httpmethodtype", + "name": "urlpath", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor url path", + "description": "The ID of LB rule", "length": 255, - "name": "urlpath", - "required": false, - "type": "string" + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "Loadbalancer health monitor timeout", + "length": 255, + "name": "timeout", + "required": true, + "type": "integer" } ], "related": "", "response": [ { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "The health monitor HTTP method", + "name": "httpmethod", "type": "string" }, {}, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "The LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" + "description": "Tungsten-Fabric provider zone ID", + "name": "zoneid", + "type": "long" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": "The health monitor interval", + "name": "interval", + "type": "int" }, { "description": "Tungsten-Fabric provider zone name", @@ -61774,51 +61742,51 @@ "type": "string" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "The health monitor UUID", + "name": "uuid", + "type": "string" }, - {}, { - "description": "the health monitor type", - "name": "type", - "type": "string" + "description": "The health monitor ID", + "name": "id", + "type": "long" + }, + { + "description": "The health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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 health monitor type", + "name": "type", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" - }, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "The health monitor expected code", + "name": "expectedcode", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "The health monitor URL path", + "name": "urlpath", "type": "string" }, { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" - } + "description": "The health monitor retry", + "name": "retry", + "type": "int" + }, + {} ] }, { @@ -61827,7 +61795,7 @@ "name": "releaseDedicatedHost", "params": [ { - "description": "the ID of the host", + "description": "The ID of the host", "length": 255, "name": "hostid", "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", @@ -61837,23 +61805,23 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -61866,36 +61834,36 @@ "name": "updateProjectInvitation", "params": [ { - "description": "account that is joining the project", + "description": "Account that is joining the project", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": false, - "type": "uuid" - }, - { - "description": "if true, accept the invitation, decline if false. True by default", + "description": "If true, accept the invitation, decline if false. True by default", "length": 255, "name": "accept", "required": false, "type": "boolean" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", + "description": "List invitations for specified account; this parameter has to be specified with domainId", "length": 255, "name": "token", "required": false, "type": "string" }, { - "description": "id of the project to join", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the project to join", "length": 255, "name": "projectid", "related": "activateProject,createProject,suspendProject", @@ -61904,38 +61872,38 @@ } ], "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", + "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" } ], "since": "3.0.0" }, { - "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", + "description": "This is supposed to revert a volume Snapshot. This command is only supported with KVM so far", "isasync": true, "name": "revertSnapshot", "params": [ { - "description": "The ID of the snapshot", + "description": "The ID of the Snapshot", "length": 255, "name": "id", "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", @@ -61946,109 +61914,118 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "The parent name of the Snapshot", + "name": "parentname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The domain name of the Snapshot's Account", + "name": "domain", + "type": "string" }, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", + "description": "Valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "Physical size of backed up 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": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "The project name of the Snapshot", + "name": "project", + "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "Display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "The Account associated with the Snapshot", + "name": "account", + "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "Type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "The date the Snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "Indicates whether the underlying storage supports reverting the volume to this Snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "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": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "The domain ID of the Snapshot's Account", + "name": "domainid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "The project id of the Snapshot", + "name": "projectid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "Valid types are hourly, daily, weekly, monthy, Template, and none.", + "name": "intervaltype", "type": "string" }, { @@ -62057,8 +62034,13 @@ "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Name of the Snapshot", + "name": "name", + "type": "string" + }, + { + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { @@ -62067,8 +62049,8 @@ "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "The parent ID of the Snapshot", + "name": "parent", "type": "string" }, { @@ -62077,122 +62059,111 @@ "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the list of resource tags associated", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "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": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the Snapshot", + "name": "id", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "The type of the Snapshot", + "name": "snapshottype", "type": "string" }, - {}, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - } + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "ID of the os on volume", + "name": "ostypeid", + "type": "string" + } ] }, { - "description": "Updates a condition for VM auto scaling", + "description": "Updates a condition for Instance auto scaling", "isasync": true, "name": "updateCondition", "params": [ - { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" - }, { "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, @@ -62201,36 +62172,43 @@ "type": "string" }, { - "description": "the ID of the condition.", + "description": "The ID of the condition.", "length": 255, "name": "id", "related": "listConditions", "required": true, "type": "uuid" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True 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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.18.0" @@ -62247,6 +62225,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -62267,72 +62252,117 @@ "name": "id", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addRegion,updateRegion", "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "True if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the region", - "name": "name", + "description": "The end point of the region", + "name": "endpoint", "type": "string" }, {}, { - "description": "the ID of the region", + "description": "The ID of the region", "name": "id", "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", + "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": "true if security groups support is enabled, false otherwise", + "description": "True if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" + } + ] + }, + { + "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,listInternalLoadBalancerElements", + "required": true, + "type": "uuid" + } + ], + "related": "listInternalLoadBalancerElements", + "response": [ {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "description": "The physical Network service provider ID of the element", + "name": "nspid", + "type": "string" + }, + { + "description": "The ID of the internal Load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Attempts Migration of a system virtual machine to the host specified.", + "description": "Attempts Migration of a System VM 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", + "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "autoselect", "required": false, "since": "4.16.0", - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "virtualmachineid", "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", @@ -62340,7 +62370,7 @@ "type": "uuid" }, { - "description": "destination Host ID to migrate VM to", + "description": "Destination Host ID to migrate Instance to", "length": 255, "name": "hostid", "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", @@ -62348,125 +62378,115 @@ "type": "uuid" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume", "length": 255, - "name": "autoselect", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "since": "4.16.0", - "type": "boolean" + "type": "uuid" } ], "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "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 Pod ID for the system VM", - "name": "podid", + "description": "The second DNS for the System VM", + "name": "dns2", "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 link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "The name of the System VM", + "name": "name", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "The systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the network domain for the system VM", + "description": "The Network domain for the System VM", "name": "networkdomain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "The Zone name for the System VM", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The gateway for the System VM", + "name": "gateway", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "The public IP address for the System VM", + "name": "publicip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "The public MAC address for the System VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The public netmask for the System VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "The Pod name for the System VM", + "name": "podname", "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 name of the system VM", - "name": "name", + "description": "The Pod ID for the System VM", + "name": "podid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, { @@ -62475,114 +62495,125 @@ "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": "guest vlan range", - "name": "guestvlan", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "The System VM type", + "name": "systemvmtype", "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 number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": "The date and time the System VM was created", + "name": "created", "type": "date" }, - {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "The agent state of the System VM", + "name": "agentstate", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "Guest VLAN range", + "name": "guestvlan", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "The ID of the System VM", + "name": "id", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Zone ID for the System VM", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The first DNS for the System VM", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The private IP address for the System VM", + "name": "privateip", "type": "string" }, + {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, { - "description": "the hostname for the system VM", + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "The hostname for the System VM", "name": "hostname", "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 private IP address for the system VM", - "name": "privateip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "The Template name for the System VM", + "name": "templatename", "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": "List the counters for VM auto scaling", + "description": "List the counters for Instance auto scaling", "isasync": false, "name": "listCounters", "params": [ { - "description": "Source of the counter.", + "description": "", "length": 255, - "name": "source", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Name of the counter.", + "description": "Source of the counter.", "length": 255, - "name": "name", + "name": "source", "required": false, "type": "string" }, @@ -62602,11 +62633,12 @@ "type": "string" }, { - "description": "", + "description": "ID of the Counter.", "length": 255, - "name": "page", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -62616,155 +62648,94 @@ "type": "integer" }, { - "description": "ID of the Counter.", + "description": "Name of the counter.", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createCounter", "response": [ + {}, { - "description": "the id of the Counter", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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", + "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": "Source of the counter.", "name": "source", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "zone id of counter", + "description": "Zone ID of counter", "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Configures an Internal Load Balancer element.", - "isasync": true, - "name": "configureInternalLoadBalancerElement", - "params": [ - { - "description": "the ID of the internal lb provider", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", - "required": true, - "type": "uuid" - }, - { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "listInternalLoadBalancerElements", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, - {}, - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, - { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Provider of the counter.", + "name": "provider", "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "remove Tungsten-Fabric tag", + "description": "Remove Tungsten-Fabric tag", "isasync": true, "name": "removeTungstenFabricTag", "params": [ { - "description": "the uuid of nics", + "description": "The UUID of Instances", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the uuid of networks", + "description": "The UUID of Tungsten-Fabric policy", "length": 255, - "name": "networkuuid", + "name": "policyuuid", "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "The UUID of Tungsten-Fabric application policy set", "length": 255, "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "the uuid of vms", + "description": "The UUID of Tungsten-Fabric tag", "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" + "name": "taguuid", + "required": true, + "type": "string" }, { - "description": "the ID of zone", + "description": "The ID of Zone", "length": 255, "name": "zoneid", "related": "createZone,listZones", @@ -62772,67 +62743,74 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "The UUID of NICs", "length": 255, - "name": "policyuuid", + "name": "nicuuid", "required": false, - "type": "string" + "type": "list" + }, + { + "description": "The UUID of Networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" } ], "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "List Tungsten-Fabric Instance", + "name": "vm", + "type": "list" + }, + { + "description": "List Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, - {}, - {}, { - "description": "list Tungsten-Fabric nic", + "description": "List Tungsten-Fabric NIC", "name": "nic", "type": "list" }, + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "list Tungsten-Fabric network", + "description": "List Tungsten-Fabric network", "name": "network", "type": "list" }, - { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - } + {} ] }, { @@ -62840,36 +62818,29 @@ "isasync": false, "name": "listVirtualRouterElements", "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": "", + "description": "List network offerings by enabled state", "length": 255, - "name": "page", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings by enabled state", + "description": "List by keyword", "length": 255, - "name": "enabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list virtual router elements by id", + "description": "List virtual router elements by id", "length": 255, "name": "id", "related": "configureVirtualRouterElement,listVirtualRouterElements", @@ -62877,7 +62848,14 @@ "type": "uuid" }, { - "description": "list virtual router elements by network service provider id", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List virtual router elements by network service provider id", "length": 255, "name": "nspid", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", @@ -62889,33 +62867,39 @@ "response": [ {}, { - "description": "the domain associated with the provider", + "description": "The domain associated with the provider", "name": "domain", "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 ID of the router", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "The physical Network service provider ID of the provider", + "name": "nspid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The project name of the address", + "name": "project", "type": "string" }, { @@ -62923,25 +62907,19 @@ "name": "enabled", "type": "boolean" }, - {}, { - "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 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 domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -62961,25 +62939,25 @@ } ], "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "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" } @@ -63002,27 +62980,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.21.0" }, @@ -63032,45 +63010,45 @@ "name": "createRoutingFirewallRule", "params": [ { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "The network of the VM the firewall rule will be created for", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "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 traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "icmpcode", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "type of the ICMP message being sent", "length": 255, - "name": "cidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The network of the VM the firewall rule will be created for", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "error code for this ICMP message", "length": 255, - "name": "icmptype", + "name": "icmpcode", "required": false, "type": "integer" }, @@ -63082,172 +63060,162 @@ "type": "boolean" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of firewall rule", "length": 255, - "name": "destcidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the starting port of firewall rule", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "destcidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the ending port of firewall rule", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" } ], - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "The state of the rule", + "name": "state", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "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 public IP address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "The starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "The ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "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 Instance ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "The Instance IP address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "Is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "The 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", + "description": "The Instance name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "The 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" } @@ -63255,38 +63223,43 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" } ], "since": "4.20.0" }, { - "description": "link a cloudstack account to a group or OU in ldap", + "description": "Link a cloudstack account to a group or OU in ldap", "isasync": false, "name": "linkAccountToLdap", "params": [ { - "description": "name of the group or OU in LDAP", + "description": "Domain admin username in LDAP ", "length": 255, - "name": "ldapdomain", - "required": true, + "name": "admin", + "required": false, "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "Creates the account under the specified role.", "length": 255, - "name": "accounttype", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "integer" - }, - { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, - "type": "string" + "since": "4.19.1", + "type": "uuid" }, { "description": "The id of the domain that is to contain the linked account.", @@ -63297,72 +63270,77 @@ "type": "uuid" }, { - "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", + "name": "accounttype", "required": false, + "type": "integer" + }, + { + "description": "Name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, "type": "string" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "Name of the account, it will be created if it does not exist", "length": 255, - "name": "type", - "required": false, + "name": "account", + "required": true, "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Type of the ldap name. GROUP or OU, defaults to GROUP", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "type", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "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", + "description": "Name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "ID of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { - "description": "type of the name in LDAP which is linked to the domain", + "description": "Type of the name in LDAP which is linked to the domain", "name": "type", "type": "string" }, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "Name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Type of the Account to auto import", + "name": "accounttype", + "type": "int" } ], "since": "4.11.0" @@ -63373,7 +63351,7 @@ "name": "disableOutOfBandManagementForHost", "params": [ { - "description": "the ID of the host", + "description": "The ID of the host", "length": 255, "name": "hostid", "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", @@ -63384,69 +63362,69 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "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 username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "The out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management driver for the host", + "description": "The out-of-band management driver for the host", "name": "driver", "type": "string" }, + { + "description": "The operation result description", + "name": "description", + "type": "string" + }, {}, { - "description": "the out-of-band management interface powerState of the host", + "description": "The out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "True if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "The operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the operation result description", - "name": "description", + "description": "The ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "The out-of-band management interface port", + "name": "port", + "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 UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -63459,7 +63437,7 @@ "name": "cancelHostAsDegraded", "params": [ { - "description": "host ID", + "description": "Host ID", "length": 255, "name": "id", "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", @@ -63470,197 +63448,198 @@ "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Comma-separated list of tags for the host", + "name": "hosttags", "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - {}, - { - "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 an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The ID of the host", + "name": "id", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "The host type", + "name": "type", + "type": "type" }, + {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "description": "The total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "true if this host 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 ID of extension for this cluster", - "name": "extensionid", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the name of the host", + "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": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "The Zone ID of the host", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ { - "description": "the list of enabled vGPUs", + "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", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "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" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -63685,232 +63664,231 @@ "type": "list" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the 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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "The Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", + "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 management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "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": "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 storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the Pod ID of the host", + "description": "The Pod ID of the host", "name": "podid", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "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 Zone name of the host", - "name": "zonename", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "True if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "The Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the date and time the host was created", + "description": "The date and time the host was created", "name": "created", "type": "date" }, - {}, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "The amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "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": "string" + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "The last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "The outgoing Network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "The number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" - } + }, + { + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + {} ], "since": "4.16.0.0" }, @@ -63936,25 +63914,25 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -63967,37 +63945,37 @@ "name": "createSecurityGroup", "params": [ { - "description": "name of the security group", + "description": "Name of the security group", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "the description of the security group", + "description": "The description of the security group", "length": 255, "name": "description", "required": false, "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "Create security group for project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "Create security group for project", + "description": "An optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "An optional account for the security group. Must be used with domainId.", "length": 255, "name": "account", "required": false, @@ -64007,371 +63985,418 @@ "related": "updateSecurityGroup", "response": [ { - "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": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", + "name": "account", + "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 starting IP of the security group rule", - "name": "startport", - "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": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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 protocol of the security group rule", - "name": "protocol", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "The name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "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", - "type": "string" + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, {}, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", + "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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "tag value", - "name": "value", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the ID of the security group", - "name": "id", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "The project name of the group", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Removes an Instance from any existing backup offering", + "isasync": true, + "name": "removeVirtualMachineFromBackupOffering", + "params": [ + { + "description": "ID of the Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Whether to force remove Instance from the backup offering that may also delete Instance backups.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "response": [ + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - } - ] + {} + ], + "since": "4.14.0" }, { - "description": "List network visibility and all accounts that have permissions to view this network.", + "description": "List Network visibility and all Accounts that have permissions to view this Network.", "isasync": false, "name": "listNetworkPermissions", "params": [ { - "description": "Lists network permission by network ID", + "description": "Lists Network permission by Network ID", "length": 255, "name": "networkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", @@ -64381,118 +64406,85 @@ ], "related": "", "response": [ - {}, { - "description": "the project the network is available for", - "name": "project", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "The ID of the domain to which the Network belongs", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Network ID", + "name": "networkid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of project the Network is available for", + "name": "projectid", + "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "The project the Network is available for", + "name": "project", "type": "string" }, + {}, { - "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 ID of project the network is available for", - "name": "projectid", + "description": "The name of the domain to which the Network belongs", + "name": "domain", "type": "string" }, { - "description": "the account the network is available for", - "name": "account", + "description": "The ID of Account the Network is available for", + "name": "accountid", "type": "string" }, - {}, { - "description": "the network ID", - "name": "networkid", + "description": "The Account the Network is available for", + "name": "account", "type": "string" } ], "since": "4.17.0" }, { - "description": "Removes a VM from any existing backup offering", - "isasync": true, - "name": "removeVirtualMachineFromBackupOffering", + "description": "Lists site 2 site VPN gateways", + "isasync": false, + "name": "listVpnGateways", "params": [ { - "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", + "description": "", "length": 255, - "name": "forced", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "ID of the virtual machine", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", - "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", + "name": "page", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Lists site 2 site vpn gateways", - "isasync": false, - "name": "listVpnGateways", - "params": [ - { - "description": "list only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, @@ -64500,50 +64492,44 @@ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "ID of the VPN gateway", "length": 255, - "name": "account", + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "id of vpc", + "description": "ID of VPC ", "length": 255, "name": "vpcid", "related": "listVPCs,createVPC,listVPCs,updateVPC", @@ -64551,94 +64537,86 @@ "type": "uuid" }, { - "description": "id of the vpn gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Is VPN gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "The VPC id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "The domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The owner", + "name": "account", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "The project name", + "name": "project", "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 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 id", + "description": "The project id", "name": "projectid", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The public IP address", + "name": "publicip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "The VPN gateway ID", + "name": "id", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "The VPC name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, {}, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" } ] }, @@ -64648,47 +64626,47 @@ "name": "addNetrisProvider", "params": [ { - "description": "the ID of zone", + "description": "Username to login into Netris", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Netris provider name", + "description": "Netris provider URL", "length": 255, - "name": "name", + "name": "netrisurl", "required": true, "type": "string" }, { - "description": "Username to login into Netris", + "description": "Netris Tenant name", "length": 255, - "name": "username", + "name": "tenantname", "required": true, "type": "string" }, { - "description": "Netris Site name", + "description": "Netris provider name", "length": 255, - "name": "sitename", + "name": "name", "required": true, "type": "string" }, { - "description": "Netris tag for vNets", + "description": "Netris Site name", "length": 255, - "name": "netristag", + "name": "sitename", "required": true, "type": "string" }, { - "description": "Netris Tenant name", + "description": "the ID of zone", "length": 255, - "name": "tenantname", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Password to login into Netris", @@ -64698,9 +64676,9 @@ "type": "string" }, { - "description": "Netris provider URL", + "description": "Netris tag for vNets", "length": 255, - "name": "netrisurl", + "name": "netristag", "required": true, "type": "string" } @@ -64708,55 +64686,55 @@ "related": "listNetrisProviders,deleteNetrisProvider", "response": [ { - "description": "Netris Provider site", - "name": "sitename", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, + {}, { - "description": "Netris Provider name", - "name": "name", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, { - "description": "Netris Tag for vNets", - "name": "netristag", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Provider name", + "name": "name", "type": "string" }, - {}, { - "description": "Netris provider uuid", - "name": "uuid", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Netris Tag for vNets", + "name": "netristag", + "type": "string" }, { - "description": "Netris Provider URL", - "name": "netrisurl", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" } ], @@ -64776,43 +64754,43 @@ "type": "uuid" }, { - "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "id of the user to be moved.", + "description": "ID of the user to be moved.", "length": 255, "name": "id", "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" + }, + { + "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11" @@ -64823,7 +64801,7 @@ "name": "releaseHostReservation", "params": [ { - "description": "the host ID", + "description": "The host ID", "length": 255, "name": "id", "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", @@ -64833,51 +64811,52 @@ ], "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", + "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", + "description": "Any text associated with the 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": "Create site to site vpn connection", + "description": "Create site to site VPN connection", "isasync": true, "name": "createVpnConnection", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "ID of the customer gateway", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", + "required": true, + "type": "uuid" }, { - "description": "connection is passive or not", + "description": "An optional field, whether to the display the VPN to the end User or not", "length": 255, - "name": "passive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "id of the vpn gateway", + "description": "ID of the VPN gateway", "length": 255, "name": "s2svpngatewayid", "related": "createVpnGateway,updateVpnGateway", @@ -64885,29 +64864,29 @@ "type": "uuid" }, { - "description": "id of the customer gateway", + "description": "Connection is passive or not", "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway,updateVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "passive", + "required": false, + "type": "boolean" } ], "related": "updateVpnConnection", "response": [ { - "description": "the owner", - "name": "account", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "The customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "The connection ID", + "name": "id", "type": "string" }, { @@ -64916,13 +64895,28 @@ "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "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": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "The project id", + "name": "projectid", "type": "string" }, { @@ -64930,74 +64924,54 @@ "name": "ikelifetime", "type": "long" }, + {}, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "State of VPN connection", + "name": "state", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", + "description": "If Force NAT Encapsulation is enabled for customer gateway", "name": "forceencap", "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "The project name", + "name": "project", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "public ip address id of the customer gateway", + "description": "Public IP address id of the customer gateway", "name": "gateway", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "The domain id of the owner", + "name": "domainid", + "type": "string" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "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 customer gateway ID", - "name": "s2scustomergatewayid", + "description": "The domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "is connection for display to the regular user", + "description": "Is connection for display to the regular user", "name": "fordisplay", "type": "boolean" }, @@ -65007,49 +64981,53 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "State of VPN connection", + "name": "passive", + "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, - {}, { - "description": "if DPD is enabled for customer gateway", + "description": "If DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "The owner", + "name": "account", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" } ] }, { - "description": "lists network that are using a brocade vcs switch", + "description": "Lists network that are using a brocade vcs switch", "isasync": false, "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -65059,302 +65037,320 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "brocade vcs switch ID", + "description": "Brocade vcs switch ID", "length": 255, "name": "vcsdeviceid", "related": "", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "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": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "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", + "description": "The ID of the Network", "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "List Networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "Network offering ID the Network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "ACL type - access type to the Network", + "name": "acltype", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "Related to what other Network configuration", + "name": "related", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the network domain", + "description": "The Network domain", "name": "networkdomain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The date this Network was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The second IPv4 DNS for the Network", + "name": "dns2", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "An optional field, whether to the display the Network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, + {}, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "The type of the Network", + "name": "type", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "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", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, + {}, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The domain ID of the Network owner", + "name": "domainid", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "The displaytext of the Network", + "name": "displaytext", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ACL name associated with the VPC Network", + "name": "aclname", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, - {}, { - "description": "the type of the network", - "name": "type", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The Network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "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": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "State of the Network", + "name": "state", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "description": "the list of services", + "description": "True if Network supports specifying IP ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "The list of services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The service provider name", + "name": "provider", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "UUID of the Network provider", + "name": "id", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", + "description": "State of the Network provider", + "name": "state", + "type": "string" + }, + { + "description": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "The provider name", "name": "name", "type": "string" } @@ -65362,243 +65358,225 @@ "type": "list" }, { - "description": "the service provider name", - "name": "provider", + "description": "The list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "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 provider name", + "description": "The capability name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The capability value", + "name": "value", "type": "string" } ], "type": "list" + } + ], + "type": "list" + }, + { + "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 service name", - "name": "name", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the name of the Network associated with this private gateway", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "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", + "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": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The name of the zone the Network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "The details of the Network", + "name": "details", + "type": "map" }, { - "description": "the name of the network", - "name": "name", + "description": "The first IPv4 DNS for the Network", + "name": "dns1", "type": "string" }, { - "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": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "True if guest Network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "the network's netmask", + "description": "The Network's netmask", "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true network requires restart", - "name": "restartrequired", + "description": "True if Network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "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", + "description": "The internet protocol of Network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "True if Network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "True if Network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" } ] @@ -65618,28 +65596,28 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "The 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", + "description": "The UUID of the latest async job acting 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.21.0" }, @@ -65648,14 +65626,6 @@ "isasync": false, "name": "listWebhookDeliveries", "params": [ - { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -65663,13 +65633,6 @@ "required": false, "type": "integer" }, - { - "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, { "description": "", "length": 255, @@ -65678,27 +65641,36 @@ "type": "integer" }, { - "description": "The event type of the Webhook delivery", + "description": "The ID of the Webhook", "length": 255, - "name": "eventtype", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be listed.", + "description": "The ID of the management server", "length": 255, - "name": "startdate", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "The ID of the management server", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "id", + "related": "", "required": false, "type": "uuid" }, + { + "description": "The event type of the Webhook delivery", + "length": 255, + "name": "eventtype", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -65707,46 +65679,47 @@ "type": "string" }, { - "description": "The ID of the Webhook", + "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" + }, + { + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be listed.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" } ], "related": "createWebhook", "response": [ + {}, { - "description": "The ID of the Webhook", - "name": "id", - "type": "string" - }, - { - "description": "The name of the Webhook", - "name": "name", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { - "description": "The state of the Webhook", - "name": "state", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "The ID of the domain in which the Webhook exists", + "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 Webhook", + "name": "name", + "type": "string" }, { "description": "The name of the domain in which the Webhook exists", @@ -65754,54 +65727,59 @@ "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, + {}, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "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 date when this Webhook was created", - "name": "created", - "type": "date" + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", + "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, - {}, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, + { + "description": "The description of the Webhook", + "name": "description", "type": "string" } ], @@ -65813,71 +65791,71 @@ "name": "dedicateHost", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "The ID of the host to update", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,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" }, { - "description": "the ID of the containing domain", + "description": "The ID of the containing domain", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" - }, - { - "description": "the ID of the host to update", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" } ], "related": "listDedicatedHosts", "response": [ + {}, { - "description": "the Account ID of the host", - "name": "accountid", - "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", - "name": "hostname", + "description": "The ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "The ID of the dedicated resource", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the host", + "name": "hostname", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", + "description": "The Dedication Affinity Group ID of the host", "name": "affinitygroupid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "The Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain ID of the host", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -65895,18 +65873,18 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Name of the Storage access group", @@ -65919,30 +65897,28 @@ "related": "", "response": [ { - "description": "List of Pods in the Storage Access Group", - "name": "pods", - "type": "listresponse" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage access group", + "name": "name", "type": "string" }, { - "description": "List of Clusters in the Storage Access Group", - "name": "clusters", + "description": "List of Storage Pools in the Storage Access Group", + "name": "storagepools", "type": "listresponse" }, { - "description": "List of Zones in the Storage Access Group", - "name": "zones", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "List of Pods in the Storage Access Group", + "name": "pods", "type": "listresponse" }, - {}, { - "description": "List of Storage Pools in the Storage Access Group", - "name": "storagepools", + "description": "List of Clusters in the Storage Access Group", + "name": "clusters", "type": "listresponse" }, { @@ -65951,19 +65927,21 @@ "type": "string" }, { - "description": "the name of the storage access group", - "name": "name", - "type": "string" + "description": "List of Zones in the Storage Access Group", + "name": "zones", + "type": "listresponse" }, { "description": "List of Hosts in the Storage Access Group", "name": "hosts", "type": "listresponse" }, + {}, + {}, { - "description": "the current status of the latest async job 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.21.0" @@ -65974,12 +65952,11 @@ "name": "addGloboDnsHost", "params": [ { - "description": "the Physical Network ID", + "description": "Username for GloboDNS", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { "description": "GloboDNS url", @@ -65989,40 +65966,41 @@ "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": "The Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ + {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -66034,17 +66012,16 @@ "isasync": false, "name": "logout", "params": [], - "related": "samlSlo", + "related": "", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -66052,7 +66029,8 @@ "description": "Response description", "name": "description", "type": "string" - } + }, + {} ] }, { @@ -66060,13 +66038,6 @@ "isasync": false, "name": "importRole", "params": [ - { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "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, @@ -66075,16 +66046,16 @@ "type": "map" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "length": 255, - "name": "type", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "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": "ispublic", + "name": "forced", "required": false, "type": "boolean" }, @@ -66101,69 +66072,76 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "related": "createRole,listRoles,updateRole", "response": [ { - "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 role", - "name": "id", - "type": "string" + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The type of the role", + "name": "type", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the state of the role", + "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 role", + "name": "name", + "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "The ID of the role", + "name": "id", "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 state of the role", - "name": "state", - "type": "string" + "description": "True if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" }, { - "description": "Updates existing email templates for quota alerts", + "description": "Updates existing email Templates for quota alerts", "isasync": false, "name": "quotaEmailTemplateUpdate", "params": [ { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", + "description": "The quota email template subject, max: 77 characters", + "length": 77, + "name": "templatesubject", "required": true, "type": "string" }, @@ -66174,44 +66152,44 @@ "required": true, "type": "string" }, - { - "description": "The quota email template subject, max: 77 characters", - "length": 77, - "name": "templatesubject", - "required": true, - "type": "string" - }, { "description": "The locale of the email text", "length": 255, "name": "locale", "required": false, "type": "string" + }, + { + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", + "required": true, + "type": "string" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "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", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {} + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.7.0" }, @@ -66221,12 +66199,11 @@ "name": "quotaCreditsList", "params": [ { - "description": "ID of the domain for which credit statement will be generated. Available only for administrators.", + "description": "End date of the credit statement. If not provided, the current date will be considered as the end date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { "description": "Start date of the credit statement. If not provided, the first day of the current month will be considered as the start date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", @@ -66236,37 +66213,36 @@ "type": "date" }, { - "description": "ID of the account for which the credit statement will be generated.", + "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "End date of the credit statement. If not provided, the current date will be considered as the end date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "ID of the account for which the credit statement will be generated.", "length": 255, - "name": "enddate", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", + "description": "ID of the domain for which credit statement will be generated. Available only for administrators.", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "quotaCredits", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "ID of the creditor user.", "name": "creditoruserid", @@ -66277,6 +66253,11 @@ "name": "currency", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The credit deposited.", "name": "credit", @@ -66287,16 +66268,13 @@ "name": "creditedon", "type": "date" }, + {}, { "description": "Username of the creditor user.", "name": "creditorusername", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.21.0" }, @@ -66305,47 +66283,222 @@ "isasync": true, "name": "restartSharedFileSystem", "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + }, { "description": "is cleanup required", "length": 255, "name": "cleanup", "required": false, "type": "boolean" + } + ], + "response": [ + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the ID of the shared filesystem", + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Imports Network ACL rules.", + "isasync": true, + "name": "importNetworkACL", + "params": [ + { + "description": "The ID of the Network ACL to which the rules will be imported", "length": 255, - "name": "id", - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" + }, + { + "description": "Rules param list, id and protocol are must. Invalid rules will be discarded. Example: rules[0].id=101&rules[0].protocol=tcp&rules[0].traffictype=ingress&rules[0].state=active&rules[0].cidrlist=192.168.1.0/24&rules[0].tags=web&rules[0].aclid=acl-001&rules[0].aclname=web-acl&rules[0].number=1&rules[0].action=allow&rules[0].fordisplay=true&rules[0].description=allow%20web%20traffic&rules[1].id=102&rules[1].protocol=udp&rules[1].traffictype=egress&rules[1].state=enabled&rules[1].cidrlist=10.0.0.0/8&rules[1].tags=db&rules[1].aclid=acl-002&rules[1].aclname=db-acl&rules[1].number=2&rules[1].action=deny&rules[1].fordisplay=false&rules[1].description=deny%20database%20traffic", + "length": 255, + "name": "rules", + "required": true, + "type": "map" } ], + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, {}, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "The ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "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", + "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 starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "The list of resource tags associated with the Network ACLs", + "name": "tags", + "response": [ + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "Type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "An explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "The current status of the latest 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 traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" + }, + { + "description": "Error code for this icmp message", + "name": "icmpcode", + "type": "integer" } ], - "since": "4.20.0" + "since": "4.22.1" }, { "description": "Lists network serviceproviders for a given physical network.", @@ -66353,40 +66506,40 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "", + "description": "List providers by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list providers by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list providers by state", + "description": "List providers by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "The Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -66399,98 +66552,98 @@ "related": "addNetworkServiceProvider,listTrafficTypes", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", "type": "string" }, {}, { - "description": "state of the network provider", - "name": "state", + "description": "The provider name", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "UUID of the Network provider", + "name": "id", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", + "description": "True if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "since": "3.0.0" }, { - "description": "delete Tungsten-Fabric tag type", + "description": "Delete Tungsten-Fabric tag type", "isasync": true, "name": "deleteTungstenFabricTagType", "params": [ { - "description": "the ID of zone", + "description": "The ID of Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "tagtypeuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of Tungsten-Fabric tag type", + "description": "The ID of zone", "length": 255, - "name": "tagtypeuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -66509,28 +66662,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": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -66550,26 +66703,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The 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" } ] }, @@ -66582,31 +66735,31 @@ "description": "The ID of the disk volume", "length": 255, "name": "id", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "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", + "description": "The 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" } @@ -66617,6 +66770,13 @@ "isasync": false, "name": "updateSecondaryStorageSelector", "params": [ + { + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" + }, { "description": "The unique identifier of the secondary storage selector.", "length": 255, @@ -66624,13 +66784,6 @@ "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "required": true, "type": "uuid" - }, - { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, - "type": "string" } ], "related": "listSecondaryStorageSelectors", @@ -66640,26 +66793,15 @@ "name": "type", "type": "string" }, - {}, - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" - }, { "description": "When the heuristic was created.", "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on 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 heuristic.", @@ -66667,24 +66809,35 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, {}, + {}, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, { "description": "ID of the heuristic.", "name": "id", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -66706,142 +66859,142 @@ ], "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ + {}, { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, - {}, { - "description": "the account name of the user", - "name": "account", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "The boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "true if user has two factor authentication enabled", + "description": "True if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user name", + "name": "username", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "The user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the date and time the user account was created", + "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 domain name of the user", - "name": "domain", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the ID of the role", + "description": "The ID of the role", "name": "roleid", "type": "string" }, { - "description": "the domain ID of the user", + "description": "The domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the user ID", - "name": "id", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "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 timezone user was created in", - "name": "timezone", + "description": "The user state", + "name": "state", "type": "string" }, { - "description": "true if user is default, false otherwise", + "description": "True if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the user state", - "name": "state", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "The user ID", + "name": "id", + "type": "string" + }, + { + "description": "The name of the role", + "name": "rolename", "type": "string" + }, + { + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" } ] }, @@ -66850,6 +67003,13 @@ "isasync": false, "name": "quotaTariffCreate", "params": [ + { + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" + }, { "description": "Position in the execution sequence for tariffs of the same type", "length": 255, @@ -66859,17 +67019,17 @@ "type": "integer" }, { - "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", - "length": 255, - "name": "startdate", + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", "required": false, - "type": "date" + "type": "string" }, { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", + "description": "Quota tariff's name", "length": 65535, - "name": "activationrule", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -66887,23 +67047,16 @@ "type": "double" }, { - "description": "Quota tariff's name", - "length": 65535, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Integer value for the usage type of the resource.", + "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "usagetype", - "required": true, - "type": "integer" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "Quota tariff's description.", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", "length": 65535, - "name": "description", + "name": "activationrule", "required": false, "type": "string" } @@ -66916,58 +67069,64 @@ "type": "bigdecimal" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", + "description": "The end date of the quota tariff", + "name": "endDate", "type": "date" }, { - "description": "name", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "Usage type description", + "name": "usageTypeDescription", + "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", - "type": "string" + "description": "Position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, { - "description": "currency", - "name": "currency", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, + {}, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "Activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "usageName", - "name": "usageName", - "type": "string" + "description": "When the quota tariff was removed", + "name": "removed", + "type": "date" }, { - "description": "description", - "name": "description", + "description": "Name", + "name": "name", "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { @@ -66976,25 +67135,19 @@ "type": "string" }, { - "description": "the ID of the tariff", + "description": "The ID of the tariff", "name": "id", "type": "string" }, - { - "description": "usageType", - "name": "usageType", - "type": "int" - }, {}, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "Currency", + "name": "currency", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description", + "name": "description", "type": "string" } ], @@ -67006,7 +67159,7 @@ "name": "suspendProject", "params": [ { - "description": "id of the project to be suspended", + "description": "ID of the project to be suspended", "length": 255, "name": "id", "related": "activateProject,createProject,suspendProject", @@ -67017,383 +67170,383 @@ "related": "activateProject,createProject", "response": [ { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "The total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "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", - "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", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "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": "tag key name", - "name": "key", + "description": "the total number of gpus owned by project", + "name": "gputotal", + "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 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 list of resource tags associated with Instance", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", "type": "string" }, { - "description": "the domain associated with the tag", + "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 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": "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", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The total number of public IP addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "The project Account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, { - "description": "the id of the project", - "name": "id", + "description": "The total number of Instances 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 gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total number of backups available to this project", + "name": "backupavailable", "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 domain name where the project belongs to", - "name": "domain", + "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", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, + {}, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", - "type": "string" + "description": "The total number of Instances running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "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 total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "The total number of Templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "The domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "The total number of VPCs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "The total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "The total number of CPU cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "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 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 backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" - }, - { - "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 total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "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 object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "The total number of CPU cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "The total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "The total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "The state of the project", + "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 CPU cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", - "type": "string" + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks the project can own", + "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 total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) owned by project", + "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 memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "The total number of Instances deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "The total number of VPCs the project can own", + "name": "vpclimit", "type": "string" }, { - "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 gpus the project can own", - "name": "gpulimit", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "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 backups available to this project", - "name": "backupavailable", + "description": "The total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of 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 total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", - "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 stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "The domain ID the project belongs to", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -67406,41 +67559,41 @@ "related": "", "response": [ { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "The Account name of the api remaining count", + "name": "account", "type": "string" }, + {}, { - "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": "number of api already issued", - "name": "apiIssued", - "type": "int" + "description": "The Account UUID of the api remaining count", + "name": "accountid", + "type": "string" }, {}, { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" + "description": "Number of API already issued", + "name": "apiIssued", + "type": "int" }, - {}, { - "description": "currently allowed number of apis", + "description": "Currently allowed number of APIs", "name": "apiAllowed", "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Seconds left to reset counters", + "name": "expireAfter", + "type": "long" } ] }, @@ -67450,7 +67603,7 @@ "name": "deleteStorageNetworkIpRange", "params": [ { - "description": "the uuid of the storage network ip range", + "description": "The UUID of the storage network IP range", "length": 255, "name": "id", "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", @@ -67460,24 +67613,24 @@ ], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" } @@ -67496,13 +67649,6 @@ "required": true, "type": "string" }, - { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "The password for specified username.", "length": 255, @@ -67518,6 +67664,13 @@ "required": true, "type": "uuid" }, + { + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, { "description": "Name of VMware datacenter to be added to specified zone.", "length": 255, @@ -67529,34 +67682,34 @@ "related": "", "response": [ { - "description": "The VMware Datacenter name", - "name": "name", + "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 UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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 VMware Datacenter ID", - "name": "id", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, + {}, { - "description": "the Zone ID associated with this VMware Datacenter", + "description": "The Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" } @@ -67568,36 +67721,30 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "The ID of the IPv6 firewall rule", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "error code for this ICMP message", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "icmpcode", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", + "description": "An optional field, whether to the display the Ipv6 firewall rule to the end User or not", "length": 255, "name": "fordisplay", "required": false, @@ -67605,196 +67752,202 @@ "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "Type of the ICMP message being sent", "length": 255, - "name": "cidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ID of the ipv6 firewall rule", + "description": "The starting port of Ipv6 firewall rule", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", - "required": true, - "type": "uuid" + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "The traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, "name": "traffictype", "required": false, "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "endport", + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "Error code for this ICMP message", + "length": 255, + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "The ending port of Ipv6 firewall rule", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" } ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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 Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The 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 public port range", - "name": "publicport", + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "The Instance 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 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", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "The protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on 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 IP address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "The ID of the port forwarding rule", + "name": "id", "type": "string" }, - {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "The ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", + "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": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", + "description": "The Instance ID for the port forwarding rule", "name": "virtualmachineid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "Is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, {} ] @@ -67805,7 +67958,7 @@ "name": "updateIsoPermissions", "params": [ { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "A comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, "name": "projectids", "related": "activateProject,createProject", @@ -67813,28 +67966,28 @@ "type": "list" }, { - "description": "true for featured template/iso, false otherwise", + "description": "True for featured Template/ISO, false otherwise", "length": 255, "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "True for public Template/ISO, false for private Templates/ISOs", "length": 255, - "name": "accounts", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "Permission operator (add, remove, reset)", "length": 255, - "name": "ispublic", + "name": "op", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the template ID", + "description": "The Template ID", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -67842,43 +67995,43 @@ "type": "uuid" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "A comma delimited list of Accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isextractable", + "name": "accounts", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "permission operator (add, remove, reset)", + "description": "True if the Template/ISO is extractable, false otherwise. Can be set only by root admin", "length": 255, - "name": "op", + "name": "isextractable", "required": false, - "type": "string" + "type": "boolean" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -67887,7 +68040,7 @@ "name": "deleteVPCOffering", "params": [ { - "description": "the ID of the VPC offering", + "description": "The ID of the VPC offering", "length": 255, "name": "id", "related": "updateVPCOffering,listVPCOfferings", @@ -67896,37 +68049,37 @@ } ], "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", + "description": "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" } ] }, { - "description": "Deletes a network ACL", + "description": "Deletes a Network ACL", "isasync": true, "name": "deleteNetworkACL", "params": [ { - "description": "the ID of the network ACL", + "description": "The ID of the Network ACL", "length": 255, "name": "id", "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", @@ -67935,27 +68088,27 @@ } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -67965,45 +68118,50 @@ "name": "listASNRanges", "params": [ { - "description": "List by keyword", + "description": "the zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "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": "the zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Start AS Number", "name": "startasn", "type": "long" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -68011,17 +68169,6 @@ "name": "endasn", "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": "Created date", "name": "created", @@ -68032,58 +68179,18 @@ "name": "id", "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Sends an email to the user with a token to reset the password using resetPassword command.", - "isasync": false, - "name": "forgotPassword", - "params": [ - { - "description": "Username", - "length": 255, - "name": "username", - "required": true, - "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.", - "length": 255, - "name": "domain", - "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID", + "name": "zoneid", "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.20.0.0" + "since": "4.20.0" }, { - "description": "create Tungsten-Fabric tag", + "description": "Create Tungsten-Fabric tag", "isasync": true, "name": "createTungstenFabricTag", "params": [ @@ -68095,62 +68202,57 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric tag value", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "tagvalue", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric tag value", + "description": "The ID of zone", "length": 255, - "name": "tagvalue", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "List Tungsten-Fabric Instance", + "name": "vm", "type": "list" }, + {}, { - "description": "list Tungsten-Fabric network", + "description": "List Tungsten-Fabric network", "name": "network", "type": "list" }, - {}, { "description": "Tungsten-Fabric tag name", "name": "name", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -68160,9 +68262,14 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "List Tungsten-Fabric NIC", + "name": "nic", + "type": "list" + }, + { + "description": "List Tungsten-Fabric policy", + "name": "policy", + "type": "list" } ] }, @@ -68172,9 +68279,9 @@ "name": "addOpenDaylightController", "params": [ { - "description": "Api URL of the OpenDaylight Controller.", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, @@ -68186,60 +68293,60 @@ "type": "string" }, { - "description": "Username to access the OpenDaylight API", + "description": "The Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "Api URL of the OpenDaylight Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "url", "required": true, - "type": "uuid" + "type": "string" } ], "related": "deleteOpenDaylightController", "response": [ - {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "Device ID of the controller", + "name": "id", "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "The username to authenticate to the controller", + "name": "username", "type": "string" }, + {}, { - "description": "the url of the controller api", + "description": "The URL of the controller API", "name": "url", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The physical Network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name assigned to the controller", + "name": "name", "type": "string" - }, - {} + } ] }, { @@ -68247,13 +68354,6 @@ "isasync": false, "name": "createZone", "params": [ - { - "description": "network type of the zone, can be Basic or Advanced", - "length": 255, - "name": "networktype", - "required": true, - "type": "string" - }, { "description": "Network domain name for the networks in the zone", "length": 255, @@ -68262,27 +68362,12 @@ "type": "string" }, { - "description": "the first internal DNS for the Zone", - "length": 255, - "name": "internaldns1", - "required": true, - "type": "string" - }, - { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "ip6dns1", + "name": "allocationstate", "required": false, "type": "string" }, - { - "description": "the ID of the containing domain, null for public zones", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "comma separated list of storage access groups for the hosts in the zone", "length": 255, @@ -68292,28 +68377,28 @@ "type": "list" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "The first DNS for the Zone", "length": 255, - "name": "ip6dns2", - "required": false, + "name": "dns1", + "required": true, "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "The second internal DNS for the Zone", "length": 255, - "name": "guestcidraddress", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "Network type of the zone, can be Basic or Advanced", "length": 255, - "name": "dns2", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "true if the zone is an edge zone, false otherwise", + "description": "True if the zone is an edge zone, false otherwise", "length": 255, "name": "isedge", "required": false, @@ -68321,44 +68406,66 @@ "type": "boolean" }, { - "description": "the name of the Zone", + "description": "True if network is security group enabled, false otherwise", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "securitygroupenabled", + "required": false, + "type": "boolean" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "True if local storage offering enabled, false otherwise", "length": 255, - "name": "allocationstate", + "name": "localstorageenabled", "required": false, + "type": "boolean" + }, + { + "description": "The first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "The second DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "dns2", "required": false, - "type": "boolean" + "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": "true if network is security group enabled, false otherwise", + "description": "The guest CIDR address for the Zone", "length": 255, - "name": "securitygroupenabled", + "name": "guestcidraddress", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "The ID of the containing domain, null for public zones", "length": 255, - "name": "internaldns2", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "The second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "type": "string" + }, + { + "description": "The first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", "required": false, "type": "string" } @@ -68366,325 +68473,325 @@ "related": "listZones", "response": [ { - "description": "Zone id", - "name": "id", + "description": "Network domain name for the Networks in the zone", + "name": "domain", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, + {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" + "description": "The type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "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": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, - {}, { - "description": "the display text of the zone", - "name": "displaytext", + "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": "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 internal DNS for the Zone", - "name": "internaldns1", + "description": "The guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "The first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "the capacity of the Zone", + "description": "The capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "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 Zone name", + "description": "The Zone name", "name": "zonename", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", + "description": "The capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The capacity name", + "name": "name", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "True, if routed Network/VPC is enabled", + "name": "routedmodeenabled", + "type": "boolean" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "The second internal DNS for the Zone", "name": "internaldns2", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "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 name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "True, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "True, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "The first internal DNS for the Zone", + "name": "internaldns1", "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": "Allow end users to specify VR MTU", "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the list of resource tags associated with zone.", + "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 zone.", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", + "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "The name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", + "description": "The UUID of the containing domain, null for public zones", "name": "domainid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "External network provider if any", + "name": "provider", + "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone id", + "name": "id", + "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "The first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "The second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Zone description", - "name": "description", + "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": "The display text of the zone", + "name": "displaytext", + "type": "string" }, { - "description": "External network provider if any", - "name": "provider", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" } ] }, @@ -68694,11 +68801,11 @@ "name": "listDomainChildren", "params": [ { - "description": "List by keyword", + "description": "To return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -68708,7 +68815,7 @@ "type": "integer" }, { - "description": "list children domain by parent domain ID.", + "description": "List children domain by parent domain ID.", "length": 255, "name": "id", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -68716,32 +68823,32 @@ "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 children domains by name", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "Flag to display the resource icon for domains", "length": 255, "name": "showicon", "required": false, "type": "boolean" }, { - "description": "list children domains by name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -68754,183 +68861,190 @@ "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "The state of the domain", + "name": "state", + "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 virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "The total number of Instances deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "The total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "The total number of Templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", - "type": "long" + "description": "The total number of Instances that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "The total number of public IP addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "The total number of CPU cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "The name of the domain", + "name": "name", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "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 total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "The total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", + "description": "The total number of public IP addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "The total number of Networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "The total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "The total number of Templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the domain ID of the parent domain", + "description": "The domain ID of the parent domain", "name": "parentdomainid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "The total number of Snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", - "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) the domain can own", - "name": "memorylimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "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 network domain", - "name": "networkdomain", - "type": "string" + "description": "The total number of VPCs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "The total number of Snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "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 vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, + {}, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "The path of the domain", + "name": "path", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "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 object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { @@ -68939,169 +69053,162 @@ "type": "resourceiconresponse" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The total number of VPCs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", + "description": "The total number of Snapshots available for this domain", "name": "snapshotavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "The total number of Networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "The ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "The total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "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) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "The total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "Details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "The total number of VPCs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, - {}, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", - "type": "string" + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "The date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "The total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The total number of Instances available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "The total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "The domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "Whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", + "description": "The total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" + "description": "The total number of Networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "The total number of public IP addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "The level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "The total volume being used by this domain", + "name": "volumetotal", "type": "long" } ] }, { - "description": "Returns an encrypted password for the VM", + "description": "Returns an encrypted password for the Instance", "isasync": false, "name": "getVMPassword", "params": [ { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } @@ -69110,18 +69217,18 @@ "response": [ {}, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "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 Instance", + "name": "encryptedpassword", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -69133,49 +69240,49 @@ "name": "assignToGlobalLoadBalancerRule", "params": [ { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "The list load balancer rules that will be assigned to global load balancer rule", "length": 255, "name": "loadbalancerrulelist", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "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", + "description": "The ID of the global load balancer rule", "length": 255, "name": "id", "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "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": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -69187,39 +69294,39 @@ "name": "addImageStoreS3", "params": [ { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "s3signer", + "name": "usetcpkeepalive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "S3 endpoint", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "endpoint", - "required": true, + "name": "s3signer", + "required": false, "type": "string" }, { - "description": "Connection TTL (milliseconds)", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "connectionttl", + "name": "connectiontimeout", "required": false, "type": "integer" }, { - "description": "Name of the storage bucket", + "description": "S3 secret key", "length": 255, - "name": "bucket", + "name": "secretkey", "required": true, "type": "string" }, { - "description": "Connection timeout (milliseconds)", + "description": "S3 access key", "length": 255, - "name": "connectiontimeout", - "required": false, - "type": "integer" + "name": "accesskey", + "required": true, + "type": "string" }, { "description": "Socket timeout (milliseconds)", @@ -69229,18 +69336,25 @@ "type": "integer" }, { - "description": "S3 access key", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "accesskey", + "name": "usehttps", + "required": false, + "type": "boolean" + }, + { + "description": "Name of the storage bucket", + "length": 255, + "name": "bucket", "required": true, "type": "string" }, { - "description": "Whether TCP keep-alive is used", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "usetcpkeepalive", + "name": "connectionttl", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "Maximum number of times to retry on error", @@ -69250,108 +69364,102 @@ "type": "integer" }, { - "description": "S3 secret key", + "description": "S3 endpoint", "length": 255, - "name": "secretkey", + "name": "endpoint", "required": true, "type": "string" - }, - { - "description": "Use HTTPS instead of HTTP", - "length": 255, - "name": "usehttps", - "required": false, - "type": "boolean" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "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": "the ID of the image store", - "name": "id", + "description": "The URL of the image store", + "name": "url", "type": "string" }, { - "description": "the scope of the image store", + "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 UUID of the latest async job acting on this object", + "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", + "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 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 image store", - "name": "zonename", + "description": "The name of the image store", + "name": "name", "type": "string" }, - {}, { - "description": "the protocol of the image store", + "description": "The protocol of the image store", "name": "protocol", "type": "string" }, + {}, { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "defines if store is read-only", + "description": "Defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "The Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the total disk size of the host", + "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", + "name": "providername", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.7.0" }, { - "description": "Upload a certificate for HTTPS direct template download on KVM hosts", + "description": "Upload a certificate for HTTPS direct Template download on KVM hosts", "isasync": false, "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Hypervisor type", + "description": "Zone to upload certificate", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "SSL certificate", @@ -69361,144 +69469,136 @@ "type": "string" }, { - "description": "Zone to upload certificate", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Name for the uploaded certificate", + "description": "Hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "(optional) the host ID to upload certificate", + "description": "(Optional) the host ID to upload certificate", "length": 255, "name": "hostid", "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" + }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, - { - "description": "the direct download certificate id", + "description": "The direct download certificate ID", "name": "id", "type": "string" }, - {}, { - "description": "the direct download certificate version", - "name": "version", + "description": "The direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "The direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", + "description": "The hypervisor of the hosts where the certificate is uploaded", "name": "hypervisor", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "The direct download certificate version", + "name": "version", "type": "string" }, + {}, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "The direct download certificate alias", + "name": "alias", "type": "string" }, + {}, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "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 issuer", + "description": "The direct download certificate issuer", "name": "issuer", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "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 alias", - "name": "alias", + "description": "The zone name where the certificate is uploaded", + "name": "zonename", "type": "string" } ], "since": "4.11.0" }, { - "description": "Import unmanaged virtual machine from a given cluster.", + "description": "Import unmanaged Instance from a given cluster.", "isasync": true, "name": "importUnmanagedInstance", "params": [ { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "VM nic to network id mapping using keys nic and network", + "description": "An optional account for the Instance. Must be used with domainId.", "length": 255, - "name": "nicnetworklist", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "the host name of the instance", + "description": "The display name of the Instance", "length": 255, - "name": "hostname", + "name": "displayname", "required": false, "type": "string" }, { - "description": "import instance for the project", + "description": "Import Instance to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", "length": 255, - "name": "datadiskofferinglist", + "name": "forced", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", + "description": "The ID of the Template for the Instance", "length": 255, "name": "templateid", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -69506,35 +69606,42 @@ "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "VM NIC to network id mapping using keys NIC and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" + }, + { + "description": "VM NIC to ip address mapping using keys NIC, ip4Address", "length": 255, "name": "nicipaddresslist", "required": false, "type": "map" }, { - "description": "the display name of the instance", + "description": "The host name of the Instance", "length": 255, - "name": "displayname", + "name": "hostname", "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": "Datadisk Template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "migrateallowed", + "name": "datadiskofferinglist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "used to specify the custom parameters.", + "description": "Used to specify the custom parameters.", "length": 255, "name": "details", "required": false, "type": "map" }, { - "description": "the cluster ID", + "description": "The cluster ID", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -69542,732 +69649,746 @@ "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "import instance to the domain specified", + "description": "Import Instance for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "The name of the Instance as it is known to the hypervisor", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the service offering for the virtual machine", + "description": "The service offering for the Instance", "length": 255, "name": "serviceofferingid", "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importVm", - "response": [ - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Instance 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" - }, + } + ], + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "User VM type", - "name": "vmtype", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "The speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", + "description": "IP addresses associated with NIC found for unmanaged Instance", "name": "ipaddresses", "type": "list" }, { - "description": "the IPv6 address of network", + "description": "The IPv6 address of Network", "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The type of the NIC", + "name": "type", + "type": "string" }, { - "description": "the isolated private VLAN if available", + "description": "The isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", + "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 ID of the nic", - "name": "id", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type ID of the Instance", + "name": "guestosid", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The ID of the domain in which the Instance exists", "name": "domainid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", "name": "memoryintfreekbs", "type": "long" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, - {}, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", + "description": "An alternate display text of the Template for the Instance", "name": "templatedisplaytext", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the group name of the virtual machine", + "description": "The group name of the Instance", "name": "group", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "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 Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "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 Instance", + "name": "account", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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", + "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 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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" }, { - "description": "the account associated with the tag", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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" } ], "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the 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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", + "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 account associated with the tag", - "name": "account", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "resource type", - "name": "resourcetype", + "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", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" } @@ -70275,460 +70396,451 @@ "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 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", + "description": "The CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "Account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "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", + "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 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" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The domain name of the security group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "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": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "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" }, { - "description": "the description of the affinity group", + "description": "The description of the affinity group", "name": "description", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "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": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", + "description": "The group ID of the Instance", "name": "groupid", "type": "string" }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "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": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "An optional field whether to the display the Instance 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 write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The ID of the availability zone for the Instance", + "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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "ssh key-pairs", + "description": "SSH key-pairs", "name": "keypairs", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + {}, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" } ], "since": "4.14.0" @@ -70750,87 +70862,87 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.21.0" }, { - "description": "Creates a physical network", + "description": "Creates a physical Network", "isasync": true, "name": "createPhysicalNetwork", "params": [ { - "description": "Tag the physical network", + "description": "The VLAN for the physical Network", "length": 255, - "name": "tags", + "name": "vlan", "required": false, - "type": "list" + "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "The Zone ID for the physical Network", "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "domain ID of the account owning a physical network", + "description": "Tag the physical Network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "tags", "required": false, - "type": "uuid" + "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 isolation method for the physical Network[VLAN/L3/GRE]", "length": 255, - "name": "broadcastdomainrange", + "name": "isolationmethods", "required": false, - "type": "string" + "type": "list" }, { - "description": "the VLAN for the physical network", + "description": "The broadcast domain range for the physical Network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", "length": 255, - "name": "vlan", + "name": "broadcastdomainrange", "required": false, "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "The name of the physical Network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the name of the physical network", + "description": "Domain ID of the Account owning a physical Network", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "The speed for the physical Network[1G/10G]", "length": 255, "name": "networkspeed", "required": false, @@ -70840,100 +70952,100 @@ "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "Zone ID of the physical Network", + "name": "zoneid", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "The domain ID of the physical Network owner", + "name": "domainid", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "Broadcast domain range of the physical Network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "State of the physical Network", + "name": "state", "type": "string" }, { - "description": "state of the physical network", - "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": "Comma separated tag", + "name": "tags", + "type": "string" }, { - "description": "zone name of the physical network", + "description": "Zone name of the physical Network", "name": "zonename", "type": "string" }, + {}, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "The UUID of the physical Network", + "name": "id", "type": "string" }, + {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Name of the physical Network", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VLAN of the physical Network", + "name": "vlan", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "Isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "The speed of the physical Network", + "name": "networkspeed", "type": "string" } ], "since": "3.0.0" }, { - "description": "Lists autoscale vm groups.", + "description": "Lists autoscale Instance groups.", "isasync": false, "name": "listAutoScaleVmGroups", "params": [ { - "description": "the ID of the policy", + "description": "The availability zone ID", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "The ID of the autoscale Instance group", "length": 255, - "name": "name", + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -70945,86 +71057,86 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The name of the autoscale vmgroup", "length": 255, - "name": "account", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the autoscale vm group", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the profile", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The ID of the loadbalancer", "length": 255, - "name": "isrecursive", + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the loadbalancer", + "description": "The ID of the policy", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, { - "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": "the ID of the profile", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" } @@ -71032,151 +71144,151 @@ "related": "enableAutoScaleVmGroup", "response": [ { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The current state of the AutoScale Instance Group", + "name": "state", "type": "string" }, + {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "List of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The autoscale profile that contains information about the Instances in the Instance group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "The Load balancer rule ID", + "name": "lbruleid", "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 lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "The date when this Instance group was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "The name of the guest Network the LB rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain name of the vm group", + "description": "The domain name of the Instance group", "name": "domain", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Is group for display to the regular User", + "name": "fordisplay", "type": "boolean" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "The name of the autoscale Instance group ", + "name": "name", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "The id of the guest Network the LB rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "The LB provider of the guest Network the LB rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "The project id of the Instance group", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "The autoscale Instance group ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public ip address", - "name": "publicip", + "description": "The project name of the Instance group", + "name": "project", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "The public port", + "name": "publicport", + "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The maximum number of members in the Instance Group, The number of Instances in the Instance 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": "List of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "The domain ID of the Instance group", + "name": "domainid", "type": "string" }, - {}, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "The private port", + "name": "privateport", + "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "The frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" } ] }, @@ -71186,52 +71298,52 @@ "name": "updatePod", "params": [ { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "The starting IP address for the Pod", "length": 255, - "name": "allocationstate", + "name": "startip", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "The ID of the Pod", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the ending IP address for the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "endip", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "The netmask of the Pod", "length": 255, - "name": "gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the ID of the Pod", + "description": "The gateway for the Pod", "length": 255, - "name": "id", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "gateway", + "required": false, + "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "The name of the Pod", "length": 255, - "name": "startip", + "name": "name", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "The ending IP address for the Pod", "length": 255, - "name": "name", + "name": "endip", "required": false, "type": "string" } @@ -71239,216 +71351,216 @@ "related": "createPod,listPods,createManagementNetworkIpRange", "response": [ { - "description": "the ID of the Pod", - "name": "id", + "description": "The name of the Pod", + "name": "name", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - {}, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "The gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "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", + "description": "The ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", "type": "list" }, - {}, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "The capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the starting IP for the range", - "name": "startip", + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "The Cluster name", + "name": "clustername", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "The Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "The Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "The Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The capacity name", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of storage access groups for the pod", - "name": "storageaccessgroups", + "description": "The Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "The netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "The IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "Indicates VLAN ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "Indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "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 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" } ] }, { - "description": "Attaches an ISO to a virtual machine.", + "description": "Attaches an ISO to an Instance.", "isasync": true, "name": "attachIso", "params": [ { - "description": "the ID of the ISO file", + "description": "The ID of the Instance", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "The ID of the ISO file", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importVm", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, @@ -71461,31 +71573,41 @@ "type": "boolean" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importVm", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { @@ -71494,794 +71616,962 @@ "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 Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "The ID of the Instance", + "name": "id", "type": "string" }, + {}, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "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 IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", + "description": "The ID of the NIC", "name": "id", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolated private VLAN if available", + "description": "The isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "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", + "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": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The gateway of IPv6 Network", "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", + "description": "True if NIC is default, false otherwise", "name": "macaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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 netmask of the NIC", + "name": "netmask", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" } ], "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", + "description": "The group ID of the Instance", "name": "groupid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "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 Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, - {}, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The list of Instance IDs associated with this Security Group", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", + "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 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 list of resource tags associated with the rule", + "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": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The 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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the code for the ICMP message response", + "description": "The code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "The project name of the group", + "name": "project", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "account owning the security group rule", + "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 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 type of the ICMP message response", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the protocol of the security group rule", + "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "Security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", + "description": "The ID of the security group", "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", + "description": "The domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the description of the security group", + "description": "The description of the security group", "name": "description", "type": "string" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the account owning the security group", + "description": "The Account owning the security group", "name": "account", "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { @@ -72290,334 +72580,161 @@ "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "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", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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 Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain name of the affinity group", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", + "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "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 updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "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", + "description": "OS name of the Instance", + "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 ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -72629,23 +72746,13 @@ "related": "", "response": [ { - "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", - "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" }, { - "description": "DN password", - "name": "bindpass", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { @@ -72653,26 +72760,36 @@ "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": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", + "type": "string" + }, { "description": "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", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" } ], @@ -72684,47 +72801,33 @@ "name": "createUser", "params": [ { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "lastname", + "description": "Email", "length": 255, - "name": "lastname", + "name": "email", "required": true, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" - }, - { - "description": "Unique username.", + "description": "Firstname", "length": 255, - "name": "username", + "name": "firstname", "required": true, "type": "string" }, { - "description": "email", + "description": "Lastname", "length": 255, - "name": "email", + "name": "lastname", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "userid", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", @@ -72741,80 +72844,88 @@ "type": "string" }, { - "description": "firstname", + "description": "Unique username.", "length": 255, - "name": "firstname", + "name": "username", "required": true, "type": "string" + }, + { + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, + "type": "string" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" } ], "related": "disableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the type of the role", - "name": "roletype", + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the 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", - "type": "string" + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the timezone user was created in", + "description": "The timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", "type": "apikeyaccess" }, - {}, - {}, { - "description": "the user name", - "name": "username", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { @@ -72823,69 +72934,75 @@ "type": "resourceiconresponse" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the 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", + "description": "The date and time the user Account was created", "name": "created", "type": "date" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "The domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" + }, + {}, + { + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The user state", + "name": "state", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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", + "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 domain name of the user", - "name": "domain", + "description": "The user email address", + "name": "email", + "type": "string" + }, + { + "description": "The user firstname", + "name": "firstname", "type": "string" + }, + { + "description": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -72895,47 +73012,40 @@ "name": "addCustomAction", "params": [ { - "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "description": "The ID of the extension to associate the action with", "length": 255, - "name": "parameters", - "required": false, - "type": "map" + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": true, + "type": "uuid" }, { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", + "description": "Success message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}", "length": 255, - "name": "timeout", + "name": "successmessage", "required": false, - "type": "integer" - }, - { - "description": "Name of the action", - "length": 255, - "name": "name", - "required": true, "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", "length": 255, - "name": "details", + "name": "parameters", "required": false, "type": "map" }, { - "description": "Error message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "description": "Whether the action is enabled or not. Default is disabled.", "length": 255, - "name": "errormessage", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The ID of the extension to associate the action with", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", - "required": true, - "type": "uuid" + "name": "timeout", + "required": false, + "type": "integer" }, { "description": "Description of the action", @@ -72945,76 +73055,46 @@ "type": "string" }, { - "description": "List of role types allowed for the action", + "description": "Resource type for which the action is available", "length": 255, - "name": "allowedroletypes", + "name": "resourcetype", "required": false, - "type": "list" + "type": "string" }, { - "description": "Resource type for which the action is available", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", "length": 255, - "name": "resourcetype", + "name": "details", "required": false, + "type": "map" + }, + { + "description": "Name of the action", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "Whether the action is enabled or not. Default is disabled.", + "description": "Error message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}", "length": 255, - "name": "enabled", + "name": "errormessage", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Success message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "description": "List of role types allowed for the action", "length": 255, - "name": "successmessage", + "name": "allowedroletypes", "required": false, - "type": "string" + "type": "list" } ], "related": "listCustomActions", "response": [ { - "description": "List of the parameters for the action", - "name": "parameters", - "response": [ - { - "description": "Type of the parameter", - "name": "type", - "type": "string" - }, - { - "description": "Name of the parameter", - "name": "name", - "type": "string" - }, - { - "description": "Whether the parameter is required or not", - "name": "required", - "type": "boolean" - }, - { - "description": "Comma-separated list of options for value of the parameter", - "name": "valueoptions", - "type": "list" - }, - { - "description": "Validation format for value of the parameter. Available for specific types", - "name": "validationformat", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Resource type for which the action is available", - "name": "resourcetype", - "type": "string" - }, - { - "description": "Message that will be used on successful execution of the action", - "name": "successmessage", + "description": "Description of the custom action", + "name": "description", "type": "string" }, { @@ -73023,24 +73103,23 @@ "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Resource type for which the action is available", + "name": "resourcetype", "type": "string" }, { - "description": "Description of the custom action", - "name": "description", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "ID of the extension that this custom action belongs to", - "name": "extensionid", + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", "type": "string" }, { @@ -73048,14 +73127,19 @@ "name": "details", "type": "map" }, + { + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, { "description": "Whether the custom action is enabled or not", "name": "enabled", "type": "boolean" }, { - "description": "Name of the custom action", - "name": "name", + "description": "ID of the custom action", + "name": "id", "type": "string" }, { @@ -73064,15 +73148,37 @@ "type": "string" }, { - "description": "List of role types allowed for the custom action", - "name": "allowedroletypes", + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + }, + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + } + ], "type": "list" }, - { - "description": "Creation timestamp of the custom action", - "name": "created", - "type": "date" - }, {}, { "description": "Message that will be used on failure during execution of the action", @@ -73080,94 +73186,37 @@ "type": "string" }, { - "description": "ID of the custom action", - "name": "id", - "type": "string" - } - ], - "since": "4.21.0" - }, - { - "description": "Resets the password for the user using the token generated via forgotPassword command.", - "isasync": false, - "name": "resetPassword", - "params": [ - { - "description": "Username", - "length": 255, - "name": "username", - "required": true, - "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.", - "length": 255, - "name": "domain", - "required": false, - "type": "string" - }, - { - "description": "Token generated via forgotPassword command.", - "length": 255, - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "New password in clear text (Default hashed to SHA256SALT).", - "length": 255, - "name": "password", - "required": true, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", + "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": "ID of the extension that this custom action belongs to", + "name": "extensionid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Name of the custom action", + "name": "name", + "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], - "since": "4.20.0.0" + "since": "4.21.0" }, { - "description": "Creates site to site vpn local gateway", + "description": "Creates site to site VPN local gateway", "isasync": true, "name": "createVpnGateway", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "An optional field, whether to the display the VPN to the end User or not", "length": 255, "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" }, - { - "description": "id of the vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - }, { "description": "the public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.", "length": 255, @@ -73176,27 +73225,35 @@ "required": false, "since": "4.21.0", "type": "uuid" + }, + { + "description": "Public IP address id of the VPN gateway", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" } ], "related": "updateVpnGateway", "response": [ { - "description": "the project id", - "name": "projectid", + "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" }, { - "description": "the owner", - "name": "account", + "description": "The project id", + "name": "projectid", "type": "string" }, { - "description": "the project name", + "description": "The project name", "name": "project", "type": "string" }, @@ -73206,52 +73263,52 @@ "type": "string" }, { - "description": "the vpc name of this gateway", + "description": "The VPC name of this gateway", "name": "vpcname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Is VPN gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, {}, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "The VPN gateway 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 public IP address", + "description": "The public IP address", "name": "publicip", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The VPC id of this gateway", + "name": "vpcid", + "type": "string" }, - {} + { + "description": "The owner", + "name": "account", + "type": "string" + } ] }, { @@ -73260,14 +73317,14 @@ "name": "addResourceDetail", "params": [ { - "description": "resource id to create the details for", + "description": "Type of the resource", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": true, "type": "string" }, { - "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "description": "Pass false if you want this detail to be disabled for the regular User. True by default", "length": 255, "name": "fordisplay", "required": false, @@ -73275,181 +73332,181 @@ "type": "boolean" }, { - "description": "Map of (key/value pairs)", + "description": "Resource ID to create the details for", "length": 255, - "name": "details", + "name": "resourceid", "required": true, - "type": "map" + "type": "string" }, { - "description": "type of the resource", + "description": "Map of (key/value pairs)", "length": 255, - "name": "resourcetype", + "name": "details", "required": true, - "type": "string" + "type": "map" } ], "response": [ { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "The 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": "Lists vpn users", + "description": "Lists VPN Users", "isasync": false, "name": "listVpnUsers", "params": [ { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The uuid of the Vpn user", + "description": "The username of the VPN User.", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "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,listDomains,listDomains,moveDomain", "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "The UUID of the VPN User", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the username of the vpn user.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "username", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addVpnUser", "response": [ { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "The Account of the remote access VPN", + "name": "account", "type": "string" }, - {}, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "The domain ID of the Account of the remote access VPN", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "The VPN user ID", + "name": "id", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "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 state of the VPN User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "The username of the VPN user", + "name": "username", "type": "string" }, + {}, { - "description": "path of the domain to which the remote access vpn belongs", + "description": "Path of the domain to which the remote access VPN belongs", "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, { - "description": "the vpn userID", - "name": "id", + "description": "The domain name of the Account of the remote access VPN", + "name": "domain", "type": "string" } ] @@ -73460,37 +73517,37 @@ "name": "deleteIpForwardingRule", "params": [ { - "description": "the ID of the forwarding rule", + "description": "The ID of the forwarding rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True 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", + "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" + }, + {} ] }, { @@ -73499,18 +73556,20 @@ "name": "registerUserData", "params": [ { - "description": "an optional account for the user data. Must be used with domainId.", + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Name of the user data", + "description": "an optional project for the user data", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" }, { "description": "comma separated list of variables declared in user data content", @@ -73520,23 +73579,21 @@ "type": "string" }, { - "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the user data. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the user data", + "description": "Name of the user data", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "User data content", + "description": "Base64 encoded User Data content. 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 32KB of data after base64 encoding, which can be increased upto 1MB using the vm.userdata.max.length setting", "length": 1048576, "name": "userdata", "required": true, @@ -73545,26 +73602,26 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, {} ], "since": "4.18" @@ -73582,59 +73639,59 @@ "type": "string" }, { - "description": "Id of the Region", + "description": "Name of the region", "length": 255, - "name": "id", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Name of the region", + "description": "Id of the Region", "length": 255, - "name": "name", + "name": "id", "required": true, - "type": "string" + "type": "integer" } ], "related": "updateRegion", "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "True if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "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 name of the region", + "description": "The name of the region", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, {}, { - "description": "the end point of the region", + "description": "The end point of the region", "name": "endpoint", "type": "string" }, - {} + {}, + { + "description": "The ID of the region", + "name": "id", + "type": "integer" + } ] }, { @@ -73649,13 +73706,6 @@ "required": false, "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": false, - "type": "date" - }, { "description": "List events for the specified domain.", "length": 255, @@ -73663,26 +73713,33 @@ "related": "createDomain,listDomains,listDomains,moveDomain", "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": false, + "type": "date" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, @@ -73695,15 +73752,6 @@ "isasync": false, "name": "updateRolePermission", "params": [ - { - "description": "Role permission rule id", - "length": 255, - "name": "ruleid", - "related": "", - "required": false, - "since": "4.11", - "type": "uuid" - }, { "description": "ID of the role", "length": 255, @@ -73712,6 +73760,14 @@ "required": true, "type": "uuid" }, + { + "description": "The parent role permission UUID, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" + }, { "description": "Rule permission, can be: allow or deny", "length": 255, @@ -73721,95 +73777,82 @@ "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "ruleid", "related": "", "required": false, - "type": "list" + "since": "4.11", + "type": "uuid" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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" + "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.9.0" }, { - "description": "Lists accounts and provides detailed account information for listed accounts", + "description": "Lists Accounts and provides detailed Account information for listed Accounts", "isasync": false, "name": "listAccounts", "params": [ { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "List Account by Account ID", "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "Comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "iscleanuprequired", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "List accounts by the Api key access value", + "description": "List Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "apikeyaccess", + "name": "accounttype", "required": false, - "since": "4.20.1.0", - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "flag to display the resource icon for accounts", + "description": "Flag to display the resource icon for accounts", "length": 255, "name": "showicon", "required": false, "type": "boolean" }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "Tag for resource type to return usage", "length": 255, @@ -73818,30 +73861,22 @@ "since": "4.20.0", "type": "string" }, - { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list account by account ID", + "description": "List account by account name", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", @@ -73849,67 +73884,64 @@ "type": "uuid" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "accounttype", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" - } - ], - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "List accounts by the Api key access value", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "List accounts by state. Valid states are enabled, disabled, and locked.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "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": "List accounts by cleanuprequired attribute (values are true or false)", + "length": 255, + "name": "iscleanuprequired", + "required": false, + "type": "boolean" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", + "description": "The total number of public IP addresses available for this Account to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { @@ -73918,123 +73950,73 @@ "type": "long" }, { - "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 backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "Name of the Domain the Account belongs to", + "name": "domain", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", + "description": "The list of ACL groups that account belongs to", + "name": "groups", "type": "list" }, { - "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 name of the Account", + "name": "name", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "The total number of Snapshots stored by this Account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "The total number of Networks owned by Account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "The total number of CPU cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "The default zone of the Account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "The total number of public IP addresses allocated for this Account", + "name": "iptotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { @@ -74043,244 +74025,148 @@ "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The total number of VPCs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total 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 projects being administrated by this account", - "name": "projecttotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total memory (in MB) owned by account", + "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 secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, { "description": "the total object storage space (in GiB) available to the account", "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "The total number of projects the Account can own", + "name": "projectlimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - {}, - {}, - { - "description": "the total 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 object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The total number of Instances running for this Account", + "name": "vmrunning", "type": "integer" }, + {}, { - "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 ID of the role", + "description": "The ID of the role", "name": "roleid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "The ID of the Account", + "name": "id", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "The total number of projects being administrated by this Account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "The date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "The total number of Networks available to be created for this Account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the 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 projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the list of users associated with account", + "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 secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "True if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "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 account ID of the user", - "name": "accountid", + "description": "The user state", + "name": "state", "type": "string" }, { @@ -74289,107 +74175,278 @@ "type": "resourceiconresponse" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account type of the user", + "description": "The Account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "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", + "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "The name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the date and time the user account was created", + "description": "The date and time the user Account was created", "name": "created", "type": "date" }, { - "description": "the user firstname", - "name": "firstname", + "description": "The user name", + "name": "username", "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" }, { - "description": "the user name", - "name": "username", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "The type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "The user ID", + "name": "id", "type": "string" } ], "type": "list" }, + {}, + { + "description": "The total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "The Network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, { - "description": "the total primary storage space (in GiB) the account can own", + "description": "The total primary storage space (in GiB) the account can own", "name": "primarystoragelimit", "type": "string" + }, + { + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "The total number of CPU cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "True if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The total number of Templates which have been created by this Account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "ID of the Domain the Account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The total number of Templates which can be created by this Account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "The total number of VPCs the Account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "The total number of Networks the Account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "The total volume which can be used by this Account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "The total volume available for this Account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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" } ] }, @@ -74399,7 +74456,7 @@ "name": "destroyRouter", "params": [ { - "description": "the ID of the router", + "description": "The ID of the router", "length": 255, "name": "id", "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", @@ -74410,502 +74467,494 @@ "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "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 domain ID associated with the router", - "name": "domainid", + "description": "The state of redundant virtual router", + "name": "redundantstate", "type": "string" }, - {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "The public MAC address for the router", + "name": "publicmacaddress", "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": "the Zone name for the router", - "name": "zonename", + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "The name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the list of nics associated with the router", + "description": "The list of NICs associated with the router", "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "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 isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", + "description": "ID of the VPC to which the NIC belongs", "name": "vpcid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", + "description": "The type of the NIC", "name": "type", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", + "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the 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 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": "Type of adapter if available", - "name": "adaptertype", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", + "description": "True if NIC is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "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 first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "role of the domain router", - "name": "role", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The version of Template", + "name": "version", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The domain ID associated with the router", + "name": "domainid", "type": "string" }, + {}, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "Role of the domain router", + "name": "role", "type": "string" }, + {}, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The name of the router", + "name": "name", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "CPU arch of the router", + "name": "arch", "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 hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The Template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the public IP address for the router", + "description": "The public IP address for the router", "name": "publicip", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "The guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project name of the address", + "description": "The project name of the address", "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The guest IP address for the router", + "name": "guestipaddress", "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "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 guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public netmask for the router", + "description": "The public netmask for the router", "name": "publicnetmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the state of the router", + "description": "The state of the router", "name": "state", "type": "state" }, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "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 Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "True if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "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 ID of the router", + "name": "id", + "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" - } - ] - }, - { - "description": "Lists image stores.", - "isasync": false, - "name": "listImageStores", - "params": [ + }, { - "description": "the name of the image store", - "length": 255, - "name": "name", - "required": false, + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "The result of the health check if available", + "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" + } + ], + "type": "list" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The Network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "The version of scripts", + "name": "scriptsversion", + "type": "string" + } + ] + }, + { + "description": "Lists image stores.", + "isasync": false, + "name": "listImageStores", + "params": [ + { + "description": "The image store protocol", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -74922,123 +74971,131 @@ "type": "string" }, { - "description": "the image store provider", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "The image store provider", "length": 255, "name": "provider", "required": false, "type": "string" }, { - "description": "read-only status of the image store", + "description": "The name of the image store", "length": 255, - "name": "readonly", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "name": "name", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the storage pool", + "description": "Read-only status of the image store", "length": 255, - "name": "id", + "name": "readonly", "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "uuid" + "since": "4.15.0", + "type": "boolean" }, { - "description": "", + "description": "The Zone ID for the image store", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the image store protocol", + "description": "The ID of the storage pool", "length": 255, - "name": "protocol", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "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": "Defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "The ID of the image store", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The URL of the image store", + "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the 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 current status of the latest async job acting on this object", + "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 name of the image store", + "name": "name", "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 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", + "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 Zone ID of the image store", + "name": "zoneid", + "type": "string" }, {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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 name of the image store", - "name": "name", + "description": "The scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "The Zone name of the image store", + "name": "zonename", "type": "string" } ], "since": "4.2.0" }, { - "description": "Deletes a account, and all users associated with this account", + "description": "Deletes an Account and all Users associated with this Account", "isasync": true, "name": "deleteAccount", "params": [ @@ -75052,28 +75109,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": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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" + } ] }, { @@ -75082,7 +75139,7 @@ "name": "disableOutOfBandManagementForCluster", "params": [ { - "description": "the ID of the cluster", + "description": "The ID of the cluster", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -75092,72 +75149,72 @@ ], "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ - {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "True if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "The out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the out-of-band management driver for the host", + "description": "The out-of-band management driver for the host", "name": "driver", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "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", + "description": "The operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "The ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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 ID of the host", - "name": "hostid", + "description": "The out-of-band management action (if issued)", + "name": "action", "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": "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" } ], "since": "4.9.0" @@ -75168,7 +75225,7 @@ "name": "activateProject", "params": [ { - "description": "id of the project to be modified", + "description": "ID of the project to be modified", "length": 255, "name": "id", "related": "activateProject,createProject", @@ -75179,383 +75236,383 @@ "related": "createProject", "response": [ { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "The total number of Templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "The total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "The total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "The total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the name of the project", - "name": "name", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "The total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "The Account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "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 public ip addresses allocated for this project", + "description": "The total number of public IP addresses allocated for this project", "name": "iptotal", "type": "long" }, + {}, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "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 object storage space (in GiB) the project can own", - "name": "objectstoragelimit", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "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", + "description": "The total number of CPU cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { - "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" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "The ID of the project", + "name": "id", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "The total number of Templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "The total number of Networks available to be created for this project", + "name": "networkavailable", "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 Templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "description": "The total number of Networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "The total number of Snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, - {}, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", - "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", + "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 displaytext of the project", + "name": "displaytext", + "type": "string" }, {}, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The state of the project", + "name": "state", + "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "The total number of VPCs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "The total number of Networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", + "description": "The total number of public IP addresses available for this project to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "The domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "The domain ID the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "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 project", + "name": "memoryavailable", "type": "string" }, { - "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 project account name of the project", - "name": "projectaccountname", + "description": "The total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "The project Account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "The total number of CPU cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "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", + "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "The total number of Instances that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", + "description": "The total number of Instances running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "The total number of Instances deployed by this project", "name": "vmtotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of backups available to this project", + "name": "backupavailable", "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 backups available to this project", - "name": "backupavailable", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The total number of public IP addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" + "description": "The list of resource tags associated with Instance", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "list" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "The total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "The total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" } ], "since": "3.0.0" @@ -75576,24 +75633,24 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, { - "description": "any text associated with the success or failure", + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" } @@ -75611,51 +75668,61 @@ "required": false, "type": "string" }, - { - "description": "the id of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, - "type": "uuid" - }, { "description": "Force management server to maintenance after the maintenance window timeout, default is false", "length": 255, "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "The UUID of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" } ], "related": "prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, { "description": "The host agents this management server is responsible for", "name": "agents", "type": "list" }, - {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The id of the management server", "name": "managementserverid", "type": "string" }, - {}, { "description": "the state of the management server", "name": "state", "type": "state" }, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - }, + {}, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", @@ -75667,17 +75734,7 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -75690,21 +75747,14 @@ "name": "deleteAlerts", "params": [ { - "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\")", + "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 IDs of the alerts", + "description": "The IDs of the alerts", "length": 255, "name": "ids", "related": "listAlerts,listAlertTypes", @@ -75712,51 +75762,73 @@ "type": "list" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "Delete by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "The 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": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", + "description": "Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.", "isasync": true, "name": "createAutoScaleVmProfile", "params": [ { - "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": "counterparam", + "required": false, + "type": "map" + }, + { + "description": "The ID of the user used to launch and destroy the Instances", "length": 255, "name": "autoscaleuserid", "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, + { + "description": "The Template of the auto deployed Instance", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, { "description": "used to specify the parameters values for the variables in userdata.", "length": 255, @@ -75766,14 +75838,37 @@ "type": "map" }, { - "description": "account that will own the autoscale VM profile", + "description": "An optional field, whether to the display the profile to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" + }, + { + "description": "The service offering of the auto deployed Instance", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "Account that will own the autoscale Instance profile", "length": 255, "name": "account", "required": false, "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", + "description": "An optional binary data that can be sent to the Instance 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, @@ -75781,15 +75876,7 @@ "type": "string" }, { - "description": "domain ID of the account owning a autoscale VM profile", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "availability zone for the auto deployed virtual machine", + "description": "Availability zone for the auto deployed Instance", "length": 255, "name": "zoneid", "related": "listZones", @@ -75797,21 +75884,13 @@ "type": "uuid" }, { - "description": "an optional project for the autoscale VM profile", + "description": "An optional project for the autoscale Instance profile", "length": 255, "name": "projectid", "related": "createProject", "required": false, "type": "uuid" }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "the ID of the Userdata", "length": 255, @@ -75822,152 +75901,130 @@ "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": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", - "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "map" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "description": "The time allowed for existing connections to get closed before an Instance is expunged", "length": 255, "name": "expungevmgraceperiod", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "Domain ID of the Account owning an autoscale Instance profile", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, "type": "uuid" } ], "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "The Account owning the Instance group", + "name": "account", + "type": "string" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "The project id Instance profile", + "name": "projectid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "is profile for display to the regular user", + "description": "Is profile for display to the regular User", "name": "fordisplay", "type": "boolean" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", - "type": "string" + "description": "The time allowed for existing connections to get closed before an Instance is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "The domain ID of the Instance profile", + "name": "domainid", "type": "string" }, - {}, { - "description": "the domain name of the vm profile", + "description": "The domain name of the Instance profile", "name": "domain", "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The ID of the User used to launch and destroy the Instances", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The availability zone to be used while deploying an Instance", + "name": "zoneid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "The service offering to be used while deploying an Instance", + "name": "serviceofferingid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Template to be used while deploying an Instance", + "name": "templateid", "type": "string" }, + {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "The project name of the Instance profile", + "name": "project", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "The autoscale Instance profile ID", + "name": "id", "type": "string" }, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Base64 encoded Instance user data", + "name": "userdata", "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 template to be used while deploying a virtual machine", - "name": "templateid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -75978,25 +76035,25 @@ "name": "registerOauthProvider", "params": [ { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "provider", + "required": true, + "type": "string" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Description of the OAuth Provider", "length": 255, - "name": "clientid", + "name": "description", "required": true, "type": "string" }, { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { "description": "Redirect URI pre-registered in the specific OAuth provider", @@ -76006,9 +76063,9 @@ "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "description", + "name": "clientid", "required": true, "type": "string" }, @@ -76021,24 +76078,24 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -76052,10 +76109,10 @@ "name": "updateGpuDevice", "params": [ { - "description": "New GPU card ID", + "description": "New parent GPU device ID (for virtual GPU devices)", "length": 255, - "name": "gpucardid", - "related": "listGpuCards", + "name": "parentgpudeviceid", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", "required": false, "type": "uuid" }, @@ -76068,24 +76125,24 @@ "type": "uuid" }, { - "description": "New parent GPU device ID (for virtual GPU devices)", + "description": "New NUMA node of the GPU device", "length": 255, - "name": "parentgpudeviceid", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "name": "numanode", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", + "description": "New GPU card ID", "length": 255, - "name": "type", + "name": "gpucardid", + "related": "listGpuCards", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "New NUMA node of the GPU device", + "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", "length": 255, - "name": "numanode", + "name": "type", "required": false, "type": "string" }, @@ -76101,44 +76158,44 @@ "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the host ID where the GPU device is attached", - "name": "hostid", - "type": "string" - }, - { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, + {}, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host name where the GPU device is attached", - "name": "hostname", - "type": "string" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { @@ -76147,24 +76204,24 @@ "type": "managedstate" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" }, { - "description": "the ID of the GPU device", - "name": "id", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" }, { "description": "the NUMA node where the GPU device is located", @@ -76172,26 +76229,26 @@ "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" - }, - {} + } ], "since": "4.21.0" }, @@ -76201,21 +76258,15 @@ "name": "listLBStickinessPolicies", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "The ID of the load balancer rule", "length": 255, - "name": "keyword", + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, @@ -76223,20 +76274,18 @@ "type": "boolean" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "", "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -76244,104 +76293,112 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "The ID of the load balancer stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": false, + "type": "uuid" } ], "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the list of stickinesspolicies", + "description": "The list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "The method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "The params of the policy", + "name": "params", + "type": "map" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "The name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" + "description": "Is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "The state of the policy", + "name": "state", + "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "The LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The description of the Stickiness policy", + "name": "description", + "type": "string" } ], "type": "list" }, + {}, + { + "description": "The Account of the Stickiness policy", + "name": "account", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "The domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the domain of the Stickiness policy", + "description": "The state of the policy", + "name": "state", + "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 current status of the latest async job acting on this object", + "description": "The description of the Stickiness policy", + "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 id of the zone the Stickiness policy belongs to", + "description": "The ID of the zone the Stickiness policy belongs to", "name": "zoneid", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -76351,7 +76408,7 @@ "name": "addUcsManager", "params": [ { - "description": "the Zone id for the ucs manager", + "description": "The Zone ID for the ucs manager", "length": 255, "name": "zoneid", "related": "listZones", @@ -76359,66 +76416,66 @@ "type": "uuid" }, { - "description": "the username of UCS", + "description": "The password of UCS", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "the name of UCS manager", + "description": "The username of UCS", "length": 255, - "name": "name", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "the name of UCS url", + "description": "The name of UCS URL", "length": 255, "name": "url", "required": true, "type": "string" }, { - "description": "the password of UCS", + "description": "The name of UCS manager", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "listUcsManagers", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the UCS manager", + "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 UCS manager", + "name": "name", + "type": "string" }, { - "description": "the zone ID of ucs manager", + "description": "The zone ID of UCS manager", "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "the ID of the ucs manager", - "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", + "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 URL of UCS manager", + "name": "url", "type": "string" } ] @@ -76429,7 +76486,7 @@ "name": "deleteVnfTemplate", "params": [ { - "description": "the ID of zone of the template", + "description": "The ID of zone of the Template", "length": 255, "name": "zoneid", "related": "listZones", @@ -76445,7 +76502,7 @@ "type": "boolean" }, { - "description": "the ID of the template", + "description": "The ID of the Template", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -76453,7 +76510,7 @@ "type": "uuid" }, { - "description": "Force delete a template.", + "description": "Force delete a Template.", "length": 255, "name": "forced", "required": false, @@ -76462,36 +76519,43 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" }, { - "description": "lists netscaler load balancer devices", + "description": "Lists netscaler load balancer devices", "isasync": false, "name": "listNetscalerLoadBalancers", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -76500,7 +76564,7 @@ "type": "integer" }, { - "description": "netscaler load balancer device ID", + "description": "Netscaler load balancer device ID", "length": 255, "name": "lbdeviceid", "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", @@ -76508,14 +76572,7 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "listPhysicalNetworks,updatePhysicalNetwork", @@ -76523,69 +76580,75 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "public IP of the NetScaler representing GSLB site", + "description": "Public IP of the NetScaler representing GSLB site", "name": "gslbproviderpublicip", "type": "string" }, - {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "The management IP address of the external load balancer", + "name": "ipaddress", "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "Device ID of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { - "description": "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": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "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": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "Device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "True if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "Private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { - "description": "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76594,40 +76657,41 @@ "type": "list" }, { - "description": "name of the provider", - "name": "provider", + "description": "Device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "The private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "Device state", + "name": "lbdevicestate", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Creates a vm group", + "description": "Creates an Instance group", "isasync": false, "name": "createInstanceGroup", "params": [ { - "description": "the domain ID of account owning the instance group", + "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, "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", @@ -76635,21 +76699,14 @@ "type": "uuid" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "The account of the Instance group. The account parameter must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The project of the instance group", + "description": "The project of the Instance group", "length": 255, "name": "projectid", "related": "createProject", @@ -76659,68 +76716,68 @@ ], "related": "updateInstanceGroup", "response": [ + {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "The project ID of the Instance group", + "name": "projectid", "type": "string" }, { - "description": "time and date the instance group was created", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the instance group", - "name": "name", + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, { - "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 ID of the instance group", - "name": "id", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the 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 project name of the instance group", + "description": "The project name of the Instance group", "name": "project", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "The domain ID of the Instance group", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -76729,42 +76786,35 @@ "name": "createLoadBalancer", "params": [ { - "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 source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" + "description": "The description of the load balancer", + "length": 4096, + "name": "description", + "required": false, + "type": "string" }, { - "description": "name of the load balancer", + "description": "Load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "name", + "name": "algorithm", "required": true, "type": "string" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "The TCP port of the Instance where the network traffic will be load balanced to", "length": 255, "name": "instanceport", "required": true, "type": "integer" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, - "type": "string" - }, - { - "description": "the network id of the source ip address", + "description": "The Network ID of the source IP address", "length": 255, "name": "sourceipaddressnetworkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", @@ -76772,21 +76822,29 @@ "type": "uuid" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "scheme", + "name": "fordisplay", + "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": "string" + "type": "integer" }, { - "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 guest network the load balancer will be created for", + "description": "The guest Network the load balancer will be created for", "length": 255, "name": "networkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", @@ -76794,346 +76852,335 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Name of the load balancer", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "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 Account of the Load Balancer", + "name": "account", + "type": "string" }, { - "description": "the Load Balancer ID", + "description": "The Load Balancer ID", "name": "id", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" - }, {}, { - "description": "the list of instances associated with the Load Balancer", + "description": "The list of Instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "The Instance ID", + "name": "id", "type": "string" }, { - "description": "the name of the instance", + "description": "The name of the Instance", "name": "name", "type": "string" }, { - "description": "the state of the instance", + "description": "The state of the Instance", "name": "state", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "The IP address of the Instance", + "name": "ipaddress", "type": "string" } ], "type": "list" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "is rule for display to the regular user", + "description": "Load Balancer source IP Network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "The domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "Is rule for display to the regular User", "name": "fordisplay", "type": "boolean" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name of the Load Balancer", + "name": "project", "type": "string" }, {}, { - "description": "the list of rules associated with the Load Balancer", + "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", + "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": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", + "description": "The description of the Load Balancer", "name": "description", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "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 domain ID of the Load Balancer", + "description": "The domain ID of the Load Balancer", "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "The name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "Load Balancer source IP", + "name": "sourceipaddress", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "Load Balancer Network id", + "name": "networkid", "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 Load Balancer", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" } ], "since": "4.2.0" }, { - "description": "Updates a user-defined VM backup schedule", + "description": "Updates a User-defined Instance backup schedule", "isasync": false, "name": "updateBackupSchedule", "params": [ { - "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", - "length": 255, - "name": "quiescevm", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", + "description": "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.", + "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", "length": 255, - "name": "timezone", - "required": true, - "type": "string" + "name": "maxbackups", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,importVm", + "name": "intervaltype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", "length": 255, - "name": "maxbackups", + "name": "quiescevm", "required": false, "since": "4.21.0", - "type": "integer" + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "intervaltype", + "name": "timezone", "required": true, "type": "string" + }, + { + "description": "ID of the Instance for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the VM backup", - "name": "id", + "description": "Account id", + "name": "accountid", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "Backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" - }, - {}, - { - "description": "description for the backup", - "name": "description", - "type": "string" + "description": "Backup status", + "name": "status", + "type": "status" }, { - "description": "domain name", - "name": "domain", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the backup", - "name": "name", + "description": "Name of the Instance", + "name": "virtualmachinename", "type": "string" }, { - "description": "zone name", - "name": "zone", - "type": "string" + "description": "Backup date", + "name": "created", + "type": "date" }, + {}, { - "description": "backup type", - "name": "type", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain ID", + "name": "domainid", "type": "string" }, - {}, { - "description": "external backup id", - "name": "externalid", + "description": "Account name", + "name": "account", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" }, + {}, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "Backup type", + "name": "type", "type": "string" }, { - "description": "Interval type of the backup", - "name": "intervaltype", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, { - "description": "backup date", - "name": "created", - "type": "date" + "description": "name of the backup", + "name": "name", + "type": "string" }, { "description": "Lists the vm specific details for the backup", @@ -77141,49 +77188,59 @@ "type": "map" }, { - "description": "account id", - "name": "accountid", + "description": "Backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "Backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "domain id", - "name": "domainid", + "description": "ID of the Instance backup", + "name": "id", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Indicates whether the VM from which the backup was taken is expunged or not", - "name": "isbackupvmexpunged", - "type": "boolean" + "description": "description for the backup", + "name": "description", + "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "Backup offering id", + "name": "backupofferingid", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "Domain name", + "name": "domain", "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "Zone name", + "name": "zone", "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "External backup id", + "name": "externalid", "type": "string" + }, + { + "description": "Backup size in bytes", + "name": "size", + "type": "long" } ], "since": "4.14.0" @@ -77194,36 +77251,36 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "URL of the Palo Alto appliance.", + "description": "The Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "supports only PaloAltoFirewall", + "description": "Supports only PaloAltoFirewall", "length": 255, "name": "networkdevicetype", "required": true, @@ -77233,95 +77290,95 @@ "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "Device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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": "the username that's used to log in to the external firewall", + "description": "The username that's used to log in to the external firewall", "name": "username", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "The private interface of the external firewall", + "name": "privateinterface", "type": "string" }, + {}, + { + "description": "Device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, { - "description": "device name", + "description": "Device name", "name": "fwdevicename", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "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 management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", + "description": "The number of times to retry requests to the external firewall", "name": "numretries", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "The private security zone of the external firewall", + "name": "privatezone", "type": "string" }, + {}, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "The public interface of the external firewall", + "name": "publicinterface", "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", + "description": "The public security zone of the external firewall", + "name": "publiczone", "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": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "The zone ID of the external firewall", + "name": "zoneid", "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" } ] @@ -77332,36 +77389,23 @@ "name": "createPrivateGateway", "params": [ { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", - "length": 255, - "name": "sourcenatsupported", - "required": false, - "type": "boolean" - }, - { - "description": "the netmask of the Private gateway", + "description": "The IP address of the Private Gateway", "length": 255, - "name": "netmask", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "the ID of the network ACL", + "description": "The Isolated Network this private gateway is associated to.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" - }, - { - "description": "the VPC network belongs to", + "description": "The VPC Network belongs to", "length": 255, "name": "vpcid", "related": "listVPCs,createVPC,listVPCs,updateVPC", @@ -77369,118 +77413,127 @@ "type": "uuid" }, { - "description": "the IP address of the Private gateaway", + "description": "The Netmask of the Private Gateway", "length": 255, - "name": "ipaddress", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the network implementation uri for the private gateway", + "description": "When true bypasses VLAN id/range overlap check during private gateway creation", + "length": 255, + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" + }, + { + "description": "The network implementation uri for the private gateway", "length": 255, "name": "vlan", "required": false, "type": "string" }, { - "description": "the Physical Network ID the network belongs to", + "description": "Source NAT supported value. Default value: false. When 'true', the source NAT is enabled on the private gateway 'false': sourcenat is not supported", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "The UUID of the Network offering to use for the private gateways Network connection", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "the gateway of the Private gateway", + "description": "The ID of the Network ACL", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" }, { - "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", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" + }, + { + "description": "The Gateway of the Private Gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" } ], "related": "createPrivateGateway,listPrivateGateways", "response": [ - {}, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "Path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "The private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "The ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "ACL ID set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain associated with the private gateway", + "name": "domain", "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": "the gateway", - "name": "gateway", + "description": "The Account associated with the private gateway", + "name": "account", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "The private gateway's IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "The project ID of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "The gateway", + "name": "gateway", "type": "string" }, { @@ -77489,58 +77542,62 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Zone ID of the private gateway", + "name": "zoneid", + "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "The ID of the private gateway", + "name": "id", "type": "string" }, { - "description": "VPC name the private gateway 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 name of the zone the private gateway belongs to", - "name": "zonename", + "description": "VPC ID the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "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 project id of the private gateway", - "name": "projectid", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the network implementation uri for the private gateway", + "description": "The Network implementation uri for the private gateway", "name": "vlan", "type": "string" } @@ -77553,10 +77610,10 @@ "name": "deleteFirewallRule", "params": [ { - "description": "the ID of the firewall rule", + "description": "The ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" } @@ -77564,25 +77621,25 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True 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" } ] }, @@ -77599,14 +77656,22 @@ "type": "string" }, { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, + "description": "Enables revocation checking for certificates", + "length": 255, + "name": "enabledrevocationcheck", + "required": false, + "since": "4.15", + "type": "boolean" + }, + { + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, "type": "string" }, { - "description": "an optional project for the SSL certificate", + "description": "An optional project for the SSL certificate", "length": 255, "name": "projectid", "related": "createProject", @@ -77614,19 +77679,19 @@ "type": "uuid" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "Domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enables revocation checking for certificates", + "description": "Password for the private key", "length": 255, - "name": "enabledrevocationcheck", + "name": "password", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { "description": "Private key", @@ -77636,95 +77701,87 @@ "type": "string" }, { - "description": "account that will own the SSL certificate", + "description": "Account that will own the SSL certificate", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "Password for the private key", - "length": 255, - "name": "password", - "required": false, + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, "type": "string" - }, - { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Certificate", + "name": "certificate", "type": "string" }, - {}, { - "description": "the project name of the certificate", - "name": "project", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Certificate chain", + "name": "certchain", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "Account for the certificate", + "name": "account", "type": "string" }, {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "name", - "name": "name", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "The project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "The domain id of the Network owner", + "name": "domainid", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "Certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "The project name of the certificate", + "name": "project", + "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "Name", + "name": "name", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" } ] @@ -77734,20 +77791,6 @@ "isasync": false, "name": "updateOauthProvider", "params": [ - { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": false, - "type": "string" - }, - { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": false, - "type": "string" - }, { "description": "OAuth provider will be enabled or disabled based on this value", "length": 255, @@ -77756,9 +77799,9 @@ "type": "boolean" }, { - "description": "Description of the OAuth Provider", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "description", + "name": "redirecturi", "required": false, "type": "string" }, @@ -77776,112 +77819,119 @@ "related": "updateOauthProvider", "required": true, "type": "uuid" + }, + { + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": false, + "type": "string" + }, + { + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Name of the provider", - "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": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "ID of the provider", - "name": "id", - "type": "string" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, {}, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "ID of the provider", + "name": "id", "type": "string" - }, - {} + } ], "since": "4.19.0" }, { - "description": "Creates site to site vpn customer gateway", + "description": "Creates site to site VPN customer gateway", "isasync": true, "name": "createVpnCustomerGateway", "params": [ { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "account", + "name": "splitconnections", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { - "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": "If DPD is enabled for VPN connection", + "description": "The Account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "dpd", + "name": "account", "required": false, - "type": "boolean" - }, - { - "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": "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": "If DPD is enabled for VPN connection", "length": 255, - "name": "ikeversion", + "name": "dpd", "required": false, - "since": "4.15.1", - "type": "string" + "type": "boolean" }, { - "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": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", @@ -77891,7 +77941,7 @@ "type": "string" }, { - "description": "create site-to-site VPN customer gateway for the project", + "description": "Create site-to-site VPN customer gateway for the project", "length": 255, "name": "projectid", "related": "createProject", @@ -77900,50 +77950,57 @@ "type": "uuid" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "forceencap", + "name": "ikelifetime", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "ESP policy of the customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "esppolicy", + "name": "ikepolicy", "required": true, "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "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": "esplifetime", + "name": "ikeversion", "required": false, - "type": "long" + "since": "4.15.1", + "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "Public IP address id of the customer gateway", "length": 255, "name": "gateway", "required": true, "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "ikepolicy", + "name": "forceencap", + "required": false, + "type": "boolean" + }, + { + "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": "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": "The domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", @@ -77954,64 +78011,114 @@ "related": "updateVpnCustomerGateway", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "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", + "type": "string" + }, + { + "description": "The domain ID of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "The project name", + "name": "project", "type": "string" }, - {}, { - "description": "name of the customer gateway", - "name": "name", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The project ID", + "name": "projectid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "The VPN gateway ID", + "name": "id", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "If Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "If DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "Lifetime of IKE SA of customer gateway", "name": "ikelifetime", "type": "long" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "The domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "Public IP address ID of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -78019,122 +78126,158 @@ "name": "ikepolicy", "type": "string" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "Guest IP of the customer gateway", + "name": "ipaddress", + "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": "addAnnotation,listAnnotations", + "response": [ + { + "description": "The name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "The creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "The UUID of the annotation", + "name": "id", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "The UUID of the entity to which this annotation pertains", + "name": "entityid", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "The type of the annotated entity", + "name": "entitytype", "type": "string" }, + {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The username of the User that entered the annotation", + "name": "username", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "The contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The removal timestamp for this annotation", + "name": "removed", + "type": "date" }, + {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "The UUID of the User that entered the annotation", + "name": "userid", "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "add a baremetal host", + "description": "Add a baremetal host", "isasync": false, "name": "addBaremetalHost", "params": [ { - "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": "the cluster name for the host", + "description": "The cluster name for the host", "length": 255, "name": "clustername", "required": false, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "List of tags to be added to the host", "length": 255, "name": "hosttags", "required": false, "type": "list" }, { - "description": "the host URL", + "description": "The password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "url", + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "Hypervisor type of the host", + "length": 255, + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "The host URL, optionally add ssh port (format: 'host:port') for KVM hosts, otherwise falls back to the port defined at the config 'kvm.host.discovery.ssh.port'", "length": 255, - "name": "ipaddress", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "comma separated list of storage access groups for the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "storageaccessgroups", + "name": "allocationstate", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "The Pod ID for the host", "length": 255, - "name": "externaldetails", - "required": false, - "since": "4.21.0", - "type": "map" + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the cluster ID for the host", + "description": "The cluster ID for the host", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -78142,37 +78285,31 @@ "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "The Zone ID for the host", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "the Zone ID for the host", + "description": "comma separated list of storage access groups for the host", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "allocationstate", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "The username for the host; required to be passed for hypervisors other than VMWare", "length": 255, "name": "username", "required": false, @@ -78182,293 +78319,307 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, - {}, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "The CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "The admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The state of the host", + "name": "state", + "type": "status" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "The amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "True if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "The 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": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "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", - "name": "cpuallocatedwithoverprovisioning", + "description": "The Pod ID of the host", + "name": "podid", "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "The Zone name of the host", + "name": "zonename", + "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 OS category ID of the host", - "name": "oscategoryid", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "events available for the host", - "name": "events", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "The memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "The host version", + "name": "version", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, - {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "The date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, - {}, { - "description": "capabilities of the host", + "description": "Capabilities of the host", "name": "capabilities", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "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 amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "The date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the host out-of-band management information", + "description": "The host out-of-band management information", "name": "outofbandmanagement", "type": "outofbandmanagementresponse" }, { - "description": "the host version", - "name": "version", + "description": "Comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "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 host", + "name": "zoneid", + "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 OS category name of the host", - "name": "oscategoryname", + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of extension for this cluster", + "name": "extensionname", "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": "GPU cards present in the host", "name": "gpugroup", @@ -78479,48 +78630,48 @@ "type": "string" }, { - "description": "the list of enabled vGPUs", + "description": "The list of enabled vGPUs", "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 X resolution per display", - "name": "maxresolutionx", + "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" } ], "type": "list" @@ -78529,9 +78680,9 @@ "type": "list" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "The ID of extension for this cluster", @@ -78539,171 +78690,77 @@ "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 CPU currently allocated", - "name": "cpuallocated", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The ID of the host", + "name": "id", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" - } - ] - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ - { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "addAnnotation,listAnnotations", - "response": [ - { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "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 an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the contents of the annotation", + "description": "The last annotation set on this host by an admin", "name": "annotation", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The host type", + "name": "type", + "type": "type" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "The OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "The outgoing Network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, + {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - {} - ], - "since": "4.11" + } + ] }, { "description": "Disables a role", @@ -78720,28 +78777,28 @@ } ], "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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", + "description": "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.20.0" }, @@ -78760,210 +78817,111 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} ], "since": "4.9.0" }, { - "description": "Update VM Schedule.", - "isasync": false, - "name": "updateVMSchedule", + "description": "Creates and automatically starts a VM from a backup.", + "isasync": true, + "name": "createVMFromBackup", "params": [ { - "description": "Enable VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, - { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "startdate", + "name": "customid", "required": false, - "type": "date" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "timezone", + "name": "keypair", "required": false, "type": "string" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "an optional group for the virtual machine", "length": 255, - "name": "schedule", + "name": "group", "required": false, "type": "string" }, { - "description": "ID of VM schedule", + "description": "availability zone for the virtual machine", "length": 255, - "name": "id", - "related": "updateVMSchedule", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "Name of the schedule", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "enddate", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "date" - } - ], - "related": "", - "response": [ - { - "description": "VM schedule is enabled", - "name": "enabled", + "since": "4.18", "type": "boolean" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Action", - "name": "action", - "type": "action" - }, - {}, - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates and automatically starts a VM from a backup.", - "isasync": true, - "name": "createVMFromBackup", - "params": [ - { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "used to specify the vApp properties.", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "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", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "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": "startvm", + "name": "affinitygroupids", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "customid", + "name": "ip6address", "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": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", "length": 255, - "name": "datadiskofferinglist", + "name": "datadisksdetails", "required": false, - "since": "4.11", + "since": "4.21.0", "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "group", + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "type": "boolean" }, { "description": "Number of days instance is leased for.", @@ -78974,109 +78932,111 @@ "type": "integer" }, { - "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": "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": "iptonetworklist", + "name": "rootdisksize", "required": false, - "type": "map" + "since": "4.4", + "type": "long" }, { - "description": "backup ID to create the VM from", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "backupid", - "related": "", - "required": true, - "type": "uuid" + "name": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "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": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.3", - "type": "map" + "type": "list" }, { - "description": "the ID of the Userdata", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "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": "userdataid", - "related": "listCniConfiguration", + "name": "boottype", "required": false, - "since": "4.18", - "type": "uuid" + "since": "4.14.0.0", + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "startvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "since": "4.21", "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, - "since": "4.13", - "type": "boolean" + "type": "list" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "leaseexpiryaction", + "name": "externaldetails", "required": false, "since": "4.21.0", - "type": "string" + "type": "map" }, { - "description": "Enable packed virtqueues or not.", + "description": "host name for the virtual machine", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "name", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "Deploy vm for the project", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "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": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "overridediskofferingid", + "related": "", "required": false, - "since": "4.21", + "since": "4.17", "type": "uuid" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "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": "boottype", + "name": "hypervisor", "required": false, - "since": "4.14.0.0", "type": "string" }, { @@ -79088,58 +79048,50 @@ "type": "boolean" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "affinitygroupnames", - "related": "createAffinityGroup,listAffinityGroups", + "name": "password", "required": false, - "type": "list" + "since": "4.19.0.0", + "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "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": "securitygroupnames", + "name": "securitygroupids", "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "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": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "list" - }, - { - "description": "the ip address for default vm's network", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "ipaddress", + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "dynamicscalingenabled", + "name": "nicmultiqueuenumber", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.18", + "type": "integer" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "size", + "name": "account", "required": false, - "type": "long" + "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": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "nicnetworklist", + "name": "keyboard", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { "description": "Controls specific policies on IO", @@ -79149,42 +79101,41 @@ "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", "length": 255, - "name": "keypairs", + "name": "nicnetworklist", "required": false, - "since": "4.17", - "type": "list" + "since": "4.15", + "type": "map" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "deploymentplanner", + "name": "size", "required": false, - "since": "4.4", - "type": "string" + "type": "long" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "the ip address for default vm's network", "length": 255, - "name": "networkids", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "ipaddress", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "iptonetworklist", "required": false, - "type": "string" + "type": "map" }, { "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.", @@ -79195,72 +79146,51 @@ "type": "string" }, { - "description": "availability zone for the virtual machine", + "description": "backup ID to create the VM from", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "backupid", + "related": "", "required": true, "type": "uuid" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "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": "iothreadsenabled", + "name": "datadiskofferinglist", "required": false, - "type": "boolean" + "since": "4.11", + "type": "map" }, { - "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": "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": "overridediskofferingid", + "name": "diskofferingid", "related": "", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", - "required": false, - "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": "an optional user generated name for the virtual machine", "length": 255, - "name": "keyboard", + "name": "displayname", "required": false, "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", - "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" - }, - { - "description": "the mac address for default vm's network", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "macaddress", + "name": "details", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { - "description": "the ipv6 address for default vm's network", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "ip6address", + "name": "networkids", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" + "type": "list" }, { "description": "Use the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.", @@ -79270,59 +79200,52 @@ "type": "boolean" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "keypair", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "description": "the mac address for default vm's network", "length": 255, - "name": "externaldetails", + "name": "macaddress", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "Deploy vm for the project", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "dynamicscalingenabled", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", "required": false, + "since": "4.21", "type": "uuid" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", - "length": 255, - "name": "password", - "required": false, - "since": "4.19.0.0", - "type": "string" - }, - { - "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", + "description": "used to specify the vApp properties.", "length": 255, - "name": "datadisksdetails", + "name": "properties", "required": false, - "since": "4.21.0", + "since": "4.15", "type": "map" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "bootintosetup", + "name": "userdatadetails", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.18", + "type": "map" }, { "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", @@ -79333,640 +79256,597 @@ "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "since": "4.21", "type": "uuid" }, { - "description": "host name for the virtual machine", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "name", + "name": "deploymentplanner", "required": false, + "since": "4.4", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the ID of the Userdata", "length": 255, - "name": "account", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", "length": 255, - "name": "userdatadetails", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "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, + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.18", "type": "map" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", + "description": "The ID of the backup offering of the Instance", "name": "backupofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "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 Instance", + "name": "zonename", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The vGPU type used by the Instance", + "name": "vgpu", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the host for the Instance", + "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": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - {}, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "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", - "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": "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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", + "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "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" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "The 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 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 value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 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 domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", + "description": "The Account owning the security group", "name": "account", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", + "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", + "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" + }, + { + "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "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", + "description": "ID of the resource", "name": "resourceid", "type": "string" } ], "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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 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" } ], "type": "set" @@ -79975,635 +79855,817 @@ "type": "set" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Instance name of the user Instance; 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 name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "description": "True if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "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": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The type of the NIC", "name": "type", "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 name of the corresponding network", - "name": "networkname", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" }, { - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", + "description": "The number of vCPUs this Instance is using", "name": "cpunumber", "type": "integer" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "The memory allocated for the Instance", + "name": "memory", "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "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 Instance", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 of the affinity group", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the account owning the affinity group", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance 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 userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" } ], "since": "4.21.0" }, { - "description": "Lists all configuration groups (primarily used for UI).", + "description": "Update Instance Schedule.", "isasync": false, - "name": "listConfigurationGroups", + "name": "updateVMSchedule", "params": [ { - "description": "List by keyword", + "description": "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "keyword", + "name": "schedule", "required": false, "type": "string" }, { - "description": "", + "description": "Enable Instance schedule", "length": 255, - "name": "page", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "lists configuration group by group name", + "description": "Name of the schedule", "length": 255, - "name": "group", + "name": "description", "required": false, "type": "string" }, { - "description": "", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "pagesize", + "name": "timezone", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "End date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "ID of Instance schedule", + "length": 255, + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" + }, + { + "description": "Start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" } ], "related": "", "response": [ + { + "description": "Description of Instance schedule", + "name": "description", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The ID of Instance schedule", + "name": "id", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the subgroups of the configuration group", - "name": "subgroup", - "response": [ - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - }, - { - "description": "the precedence of the configuration subgroup", - "name": "precedence", - "type": "long" - } - ], - "type": "list" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + { + "description": "Cron formatted Instance schedule", + "name": "schedule", + "type": "string" + }, + { + "description": "ID of Instance", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all configuration groups (primarily used for UI).", + "isasync": false, + "name": "listConfigurationGroups", + "params": [ + { + "description": "Lists configuration group by group name", + "length": 255, + "name": "group", + "required": false, + "type": "string" }, { - "description": "the name of the configuration group", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The name of the configuration group", "name": "name", "type": "string" }, + {}, + {}, { - "description": "the description of the configuration group", + "description": "The description of the configuration group", "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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 precedence of the configuration group", + "name": "precedence", + "type": "long" + }, + { + "description": "The subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "The precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + }, + { + "description": "The name of the configuration subgroup", + "name": "name", + "type": "string" + } + ], + "type": "list" + } ], "since": "4.18.0" }, @@ -80622,36 +80684,36 @@ ], "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ] }, { - "description": "Updates remote access vpn", + "description": "Updates remote access VPN", "isasync": true, "name": "updateRemoteAccessVpn", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "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, @@ -80659,7 +80721,7 @@ "type": "string" }, { - "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, @@ -80667,7 +80729,7 @@ "type": "boolean" }, { - "description": "id of the remote access vpn", + "description": "ID of the remote access VPN", "length": 255, "name": "id", "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", @@ -80678,80 +80740,80 @@ "related": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ { - "description": "the project name of the vpn", - "name": "project", + "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": "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 UUID of the latest async job acting on this object", + "name": "jobid", "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 range of ips to allocate to the clients", - "name": "iprange", + "description": "The IPSec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain ID of the Account of the remote access VPN", + "name": "domainid", "type": "string" }, + {}, { - "description": "the account of the remote access vpn", + "description": "The Account of the remote access VPN", "name": "account", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "The state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the 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", + "description": "The ID of the remote access VPN", + "name": "id", "type": "string" }, { - "description": "the project id of the vpn", + "description": "The project ID of the VPN", "name": "projectid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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": "Path of the domain to which the remote access VPN belongs", + "name": "domainpath", + "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "The public IP address of the VPN server", + "name": "publicip", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "The domain name of the Account of the remote access VPN", + "name": "domain", "type": "string" } ], @@ -80766,17 +80828,16 @@ "description": "the virtual machine ID to which the GPU device is allocated", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "the GPU card ID associated with the GPU device", + "description": "", "length": 255, - "name": "gpucardid", - "related": "listGpuCards", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the vGPU profile ID assigned to the GPU device", @@ -80787,25 +80848,26 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "ID of the GPU device", "length": 255, - "name": "keyword", + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host ID where the GPU device is attached", + "description": "the GPU card ID associated with the GPU device", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "gpucardid", + "related": "listGpuCards", "required": false, "type": "uuid" }, { - "description": "ID of the GPU device", + "description": "the host ID where the GPU device is attached", "length": 255, - "name": "id", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, @@ -80817,48 +80879,38 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" - }, - { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" - }, - { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { @@ -80867,62 +80919,72 @@ "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", - "type": "string" + "description": "The current status of the latest 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": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, + {}, + {}, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "the NUMA node where the GPU device is located", + "name": "numanode", + "type": "string" }, - {}, { - "description": "the managed state of the GPU device (Enabled/Disabled)", - "name": "managedstate", - "type": "managedstate" + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" }, - {}, { "description": "the vGPU profile name assigned to this GPU device", "name": "virtualmachinename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the ID of the GPU device", - "name": "id", - "type": "string" + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" } ], "since": "4.21.0" }, { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", + "description": "Destroys an Instance. Once destroyed, only the administrator can recover it.", "isasync": true, "name": "destroyVirtualMachine", "params": [ @@ -80930,13 +80992,13 @@ "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, "name": "volumeids", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "since": "4.12.0", "type": "list" }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "If true is passed, the Instance is expunged immediately. False by default.", "length": 255, "name": "expunge", "required": false, @@ -80944,563 +81006,387 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the read (IO) of disk on the VM", + "description": "The read (IO) of disk on the Instance", "name": "diskioread", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "The internal memory (KiB) that's free in Instance 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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the 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", - "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": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "The project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "Instance 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 domain name of the affinity group", - "name": "domain", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, + {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "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": "User VM type", - "name": "vmtype", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 gateway of IPv6 Network", + "name": "ip6gateway", + "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 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", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { @@ -81509,198 +81395,182 @@ "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 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": "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": "Tag key name", + "name": "key", "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": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" } @@ -81708,346 +81578,406 @@ "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", + "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 starting IP of the security group rule", + "description": "The starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the protocol of the security group rule", + "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", + "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" }, { - "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "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 egress rules associated with the security group", - "name": "egressrule", + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", + "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": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The 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 account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", + "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": "set" + }, + { + "description": "The Account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "The domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The name of the security group", + "name": "name", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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 vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + {}, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -82056,33 +81986,73 @@ "type": "long" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "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", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "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": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { @@ -82091,82 +82061,179 @@ "type": "list" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "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 Instance", + "name": "zonename", "type": "string" } ] }, { - "description": "Assigns a VM to a backup offering", + "description": "Assigns an Instance to a backup offering", "isasync": true, "name": "assignVirtualMachineToBackupOffering", "params": [ { - "description": "ID of the virtual machine", + "description": "ID of the backup offering", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": true, "type": "uuid" }, { - "description": "ID of the backup offering", + "description": "ID of the Instance", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "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", + "description": "The current status of the latest async job acting 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], "since": "4.14.0" }, { - "description": "Starts a virtual machine.", + "description": "Starts an Instance.", "isasync": true, "name": "startVirtualMachine", "params": [ { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "description": "True by default, CloudStack will firstly try to start the Instance on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the Instance by normal process.", "length": 255, "name": "considerlasthost", "required": false, @@ -82174,11 +82241,28 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "Destination Pod ID to deploy the Instance to - parameter available for root admin only", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "Destination Host ID to deploy the Instance to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "since": "3.0.1", + "type": "uuid" + }, + { + "description": "Destination Cluster ID to deploy the Instance to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { @@ -82190,7 +82274,7 @@ "type": "boolean" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "Deployment planner to use for Instance allocation. Available to ROOT admin only", "length": 255, "name": "deploymentplanner", "required": false, @@ -82198,1497 +82282,1485 @@ "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "The ID of the Instance", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "since": "3.0.1", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" - }, + } + ], + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "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,updateCluster", - "required": false, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "response": [ - { - "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", + "description": "List of variables and values for the variables declared in userdata", "name": "userdatadetails", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The group name of the Instance", + "name": "group", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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 description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "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", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the description of the security group", - "name": "description", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "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", + "description": "The ID of the service offering of the Instance", "name": "serviceofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "ID of the resource", + "name": "resourceid", "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" } ], "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", "type": "boolean" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The ID of the host for the Instance", + "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 service offering of the Instance", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "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": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "the group ID of the virtual machine", + "description": "The group ID of the Instance", "name": "groupid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", "type": "date" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "The date when this Instance was created", + "name": "created", "type": "date" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - } - ] - }, - { - "description": "Lists the resource icon for the specified resource(s)", - "isasync": false, - "name": "listResourceIcon", - "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance 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 outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "base64 representation of resource icon", - "name": "base64image", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Creates a new Pod.", - "isasync": false, - "name": "createPod", - "params": [ + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { - "description": "the ending IP address for the Pod", - "length": 255, - "name": "endip", - "required": false, + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the starting IP address for the Pod", - "length": 255, - "name": "startip", - "required": false, + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "comma separated list of storage access groups for the hosts in the pod", - "length": 255, - "name": "storageaccessgroups", - "required": false, - "since": "4.21.0", - "type": "list" + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the netmask for the Pod", - "length": 255, - "name": "netmask", - "required": false, + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the gateway for the Pod", - "length": 255, - "name": "gateway", - "required": false, + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "listPods,createManagementNetworkIpRange", - "response": [ + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "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": "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" + }, + { + "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": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The 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 capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The Account owning the security group", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" }, { - "description": "the Zone ID of the Pod", + "description": "The ID of the availability zone for the Instance", "name": "zoneid", "type": "string" + } + ] + }, + { + "description": "Lists the resource icon for the specified resource(s)", + "isasync": false, + "name": "listResourceIcon", + "params": [ + { + "description": "List of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "Type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Base64 representation of resource icon", + "name": "base64image", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "Resource type", + "name": "resourcetype", + "type": "resourceobjecttype" + }, + { + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Creates a new Pod.", + "isasync": false, + "name": "createPod", + "params": [ + { + "description": "The name of the Pod", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The Zone ID in which the Pod will be created", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for the hosts in the pod", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", "type": "list" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "description": "The netmask for the Pod", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "The ending IP address for the Pod", + "length": 255, "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "The starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this Pod for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "The gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + } + ], + "related": "listPods,createManagementNetworkIpRange", + "response": [ + { + "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": "comma-separated list of storage access groups for the pod", - "name": "storageaccessgroups", + "description": "The gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "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": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "The Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "The capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the ending IP for the range", - "name": "endip", + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "The capacity name", + "name": "name", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "The Zone name", + "name": "zonename", "type": "string" + }, + { + "description": "The percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "The Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "the name of the Pod", - "name": "name", + "description": "The allocation state of the Pod", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the netmask of the Pod", + "description": "The netmask of the Pod", "name": "netmask", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "The ID of the Pod", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The Zone name of the Pod", + "name": "zonename", + "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", - "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "The IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "The gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "The starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "The ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "Indicates VLAN ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "The CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "Indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + } + ], "type": "list" }, { - "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "type": "string" }, {} @@ -83709,27 +83781,27 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.6.0" }, @@ -83738,14 +83810,6 @@ "isasync": true, "name": "provisionCertificate", "params": [ - { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "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, @@ -83753,6 +83817,14 @@ "required": false, "type": "boolean" }, + { + "description": "The host/agent ID to which the certificate has to be provisioned (issued and propagated)", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -83764,26 +83836,26 @@ "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "the 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", + "description": "The 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" }, @@ -83793,62 +83865,68 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "list by the service offering", + "description": "List Instances by ISO", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "isoid", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "List Instances by affinity group", "length": 255, - "name": "hypervisor", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list vms by template", + "description": "The availability zone ID", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled", "length": 255, - "name": "account", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "description": "The target hypervisor for the Template", "length": 255, - "name": "gpuenabled", + "name": "hypervisor", "required": false, - "since": "4.21.0", - "type": "boolean" + "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.", + "description": "The IDs of the Instances, mutually exclusive with id", "length": 255, - "name": "accumulate", + "name": "ids", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.17.0", - "type": "boolean" + "since": "4.4", + "type": "list" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "The storage ID where vm's volumes belong to", "length": 255, "name": "storageid", "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", @@ -83856,65 +83934,67 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The user ID that created the Instance and is under the Account that owns the Instance", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "list vms by vpc", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the host ID", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "List by Network type; true if need to list Instances using Virtual Network, false otherwise", "length": 255, - "name": "keyword", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "List by the service offering", "length": 255, - "name": "forvirtualnetwork", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "CPU arch of the VM", + "description": "List by the backup offering", "length": 255, - "name": "arch", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": false, - "since": "4.20.1", - "type": "string" + "since": "4.17", + "type": "uuid" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "description": "The cluster ID", "length": 255, - "name": "details", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "list" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -83924,1086 +84004,683 @@ "type": "map" }, { - "description": "", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "pagesize", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, - "type": "integer" + "since": "4.21.0", + "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 network id", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of AutoScaling Instance Group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - }, - { - "description": "the security group ID", + "description": "The ID of the Instance", "length": 255, - "name": "securitygroupid", - "related": "updateSecurityGroup", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "list vms by iso", + "description": "Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "isoid", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "List Instances by VPC", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "Whether to return the Instances' User data or not. By default, User data will not be returned.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "userdata", "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "list by the backup offering", + "description": "List Instances by SSH keypair name", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", + "name": "keypair", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { - "description": "the availability zone ID", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", "length": 255, - "name": "isvnf", + "name": "gpuenabled", "required": false, - "since": "4.19.0", + "since": "4.21.0", "type": "boolean" }, { - "description": "the group ID", + "description": "Whether to return only leased instances", "length": 255, - "name": "groupid", - "related": "updateInstanceGroup", + "name": "leased", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "List by Network ID", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "since": "4.21.0", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Accumulates the Instance 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": "displayvm", + "name": "accumulate", "required": false, - "since": "4.4", + "since": "4.17.0", "type": "boolean" }, { - "description": "the pod ID", + "description": "the instances by userdata", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "the ID of AutoScaling VM Group", + "description": "Flag to display the resource icon for Instances", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup", + "name": "showicon", "required": false, - "since": "4.18.0", - "type": "uuid" + "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.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "the instances by userdata", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.20.1", - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster ID", + "description": "The security group ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "securitygroupid", + "related": "updateSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "List Instances by Template", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The pod ID", "length": 255, - "name": "isrecursive", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "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": "Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "CPU arch of the VM", "length": 255, - "name": "userdata", + "name": "arch", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "since": "4.20.1", + "type": "string" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "The host ID", "length": 255, - "name": "name", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "The group ID", "length": 255, - "name": "haenable", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "Whether to return only leased instances", + "description": "", "length": 255, - "name": "leased", + "name": "page", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "flag to display the resource icon for VMs", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "showicon", + "name": "isvnf", "required": false, - "since": "4.16.0.0", + "since": "4.19.0", "type": "boolean" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", + "description": "The name of the service offering of the Instance", "name": "serviceofferingname", "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Network read in MiB", + "name": "networkread", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the state of the virtual machine", + "description": "The state of the Instance", "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 ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - {}, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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", - "type": "string" + "description": "The incoming Network traffic on the Instance 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": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", + "description": "The outgoing Network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "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", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the video RAM size in MB", + "name": "videoram", "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": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The group name of the Instance", + "name": "group", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the 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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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 project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "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 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "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 gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "network write in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "network read in MiB", - "name": "networkread", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The 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 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 account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", + "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" } ], "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 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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "Security group name", + "name": "securitygroupname", "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "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", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "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": "customer associated with the tag", - "name": "customer", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" } @@ -85011,32 +84688,12 @@ "type": "set" }, { - "description": "the type of the ICMP message response", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", + "description": "The starting IP of the security group rule", "name": "startport", "type": "integer" } @@ -85044,676 +84701,1070 @@ "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "The description of the security group", + "name": "description", "type": "string" }, { "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "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 total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "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 name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "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 maximum number of display heads", - "name": "maxheads", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the Instance 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 Secondary IPv4 addr of NIC", + "name": "secondaryip", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 IPv6 address of Network", + "name": "ip6address", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The 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 ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + {}, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "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 account owning the affinity group", + "name": "account", "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": "id of the resource", - "name": "resourceid", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - } - ] - }, - { - "description": "Lists hosts.", - "isasync": false, - "name": "listHosts", - "params": [ - { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", - "length": 255, - "name": "resourcestate", - "required": false, + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the id of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, - "since": "4.21.0", - "type": "uuid" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": false, - "type": "uuid" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "the name of the storage access group", - "length": 255, - "name": "storageaccessgroup", - "required": false, - "since": "4.21.0", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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, + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "CPU Arch of the host", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20.1", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "list hosts for which out-of-band management is enabled", - "length": 255, - "name": "outofbandmanagementenabled", - "required": false, - "type": "boolean" + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the id of the host", - "length": 255, - "name": "id", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", - "length": 255, - "name": "hahost", - "required": false, - "type": "boolean" + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "lists hosts existing in particular cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "Disk read in MiB", + "name": "diskread", + "type": "string" }, { - "description": "the state of the host", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the host type", - "length": 255, - "name": "type", - "required": false, + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the host", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "declareHostAsDegraded,reconnectHost", - "response": [ - { - "description": "events available for the host", - "name": "events", + "description": "Disk write in MiB", + "name": "diskwrite", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, + {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "Network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "The total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "The total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, + } + ] + }, + { + "description": "Lists hosts.", + "isasync": false, + "name": "listHosts", + "params": [ { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "List hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "length": 255, + "name": "resourcestate", + "required": false, "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "Comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, - {}, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "The Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "If true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "The ID of the host", + "length": 255, + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" + "description": "Lists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "GPU cards present in the host", + "description": "List hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "The host type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "The state of the host", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "CPU Arch of the host", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" + }, + { + "description": "Lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "The Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the host version", + "length": 255, + "name": "version", + "required": false, + "since": "4.20.3", + "type": "string" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "The name of the host", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "declareHostAsDegraded,reconnectHost", + "response": [ + { + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "The amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "The host type", + "name": "type", + "type": "type" + }, + { + "description": "True if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "The host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "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 date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + {}, + { + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "The host version", + "name": "version", + "type": "string" + }, + { + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The average CPU 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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "The ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "The CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "GPU cards present in the host", "name": "gpugroup", "response": [ { - "description": "the list of enabled vGPUs", + "description": "The list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, { "description": "Video RAM for this vGPU type", "name": "videoram", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more Instances that can be deployed 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": "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" }, { @@ -85722,13 +85773,18 @@ "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum 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" } ], @@ -85743,201 +85799,230 @@ "type": "list" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "Comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "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 used", - "name": "memoryused", - "type": "long" + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "Events available for the host", + "name": "events", + "type": "string" }, { - "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 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 allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", - "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 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": "True if this host has enough CPU and RAM capacity to migrate an Instance 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": "The memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "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": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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 Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "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": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the cluster name of the host", + "description": "The CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "The cluster name of the host", "name": "clustername", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The state of the host", + "name": "state", + "type": "status" + }, + { + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the hypervisor version", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "The hypervisor version", "name": "hypervisorversion", "type": "string" }, {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "The last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, - {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "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", + "description": "The outgoing Network traffic on the host", + "name": "networkkbswrite", "type": "long" + }, + { + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" } ] }, @@ -85964,26 +86049,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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, { - "description": "true if operation is executed successfully", + "description": "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" } ] }, @@ -86002,28 +86087,28 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.17.0.0" }, @@ -86033,18 +86118,19 @@ "name": "updateStoragePool", "params": [ { - "description": "comma-separated list of tags for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "tags", + "name": "capacityiops", "required": false, - "type": "list" + "type": "long" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "the URL of the storage pool", "length": 255, - "name": "enabled", + "name": "url", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -86054,29 +86140,37 @@ "type": "boolean" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "False to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "capacitybytes", + "name": "enabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the details for the storage pool", + "description": "Comma-separated list of tags for the storage pool", "length": 255, - "name": "details", + "name": "tags", "required": false, - "since": "4.19.0", - "type": "map" + "type": "list" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "Change the name of the storage pool", "length": 255, - "name": "capacityiops", + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.15", + "type": "string" + }, + { + "description": "Bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", "required": false, "type": "long" }, { - "description": "the Id of the storage pool", + "description": "The Id of the storage pool", "length": 255, "name": "id", "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", @@ -86084,97 +86178,113 @@ "type": "uuid" }, { - "description": "the URL of the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "url", + "name": "details", "required": false, "since": "4.19.0", - "type": "string" - }, - { - "description": "Change the name of the storage pool", - "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.15", - "type": "string" + "type": "map" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "the date and time the storage pool was created", + "description": "The date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the Pod ID of the storage pool", + "description": "The Pod ID of the storage pool", "name": "podid", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "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": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "The storage pool type", + "name": "type", "type": "string" }, { - "description": "the tags for the storage pool", + "description": "The state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "The tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "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": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "The name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "The Zone name of the storage pool", + "name": "zonename", + "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 ID of the storage pool", + "description": "The ID of the storage pool", "name": "id", "type": "string" }, @@ -86184,44 +86294,44 @@ "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "True if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "The IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "The scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", - "type": "long" + "description": "The Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -86229,61 +86339,36 @@ "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", + "description": "The ID of the cluster for the storage pool", "name": "clusterid", "type": "string" }, - {}, { "description": "whether this pool is managed or not", "name": "managed", "type": "boolean" }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, {}, { - "description": "the pool's currently allocated disk size", + "description": "The pool's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, + {}, { - "description": "the hypervisor type of the storage pool", + "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 Zone name of the storage pool", - "name": "zonename", + "description": "The name of the storage pool", + "name": "name", "type": "string" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" } ], "since": "3.0.0" @@ -86294,67 +86379,62 @@ "name": "listBackupRepositories", "params": [ { - "description": "List by keyword", + "description": "name of the backup repository", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the backup repository provider", + "description": "ID of the backup repository", "length": 255, - "name": "provider", + "name": "id", + "related": "addBackupRepository,listBackupRepositories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "name of the backup repository", + "description": "the backup repository provider", "length": 255, - "name": "name", + "name": "provider", "required": false, "type": "string" }, { - "description": "ID of the backup repository", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addBackupRepository,listBackupRepositories", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "ID of the zone where the backup repository is to be added", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addBackupRepository", "response": [ { - "description": "the Zone name of the backup repository", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "backup type", + "name": "type", "type": "string" }, { @@ -86362,41 +86442,46 @@ "name": "zoneid", "type": "string" }, - {}, { "description": "the name of the backup repository", "name": "name", "type": "string" }, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the backups in this repository can be used to create Instances on all Zones", - "name": "crosszoneinstancecreation", - "type": "boolean" + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" }, + {}, { - "description": "backup type", - "name": "type", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "mount options", + "name": "mountopts", + "type": "string" }, { - "description": "the address / url of the backup repository", - "name": "address", + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + { + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, { @@ -86408,6 +86493,11 @@ "description": "name of the provider", "name": "provider", "type": "string" + }, + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" } ], "since": "4.20.0" @@ -86418,19 +86508,18 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric tag", + "description": "The uuid of Tungsten-Fabric NIC", "length": 255, - "name": "taguuid", + "name": "nicuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "The uuid of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "policyuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -86440,21 +86529,14 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric network", + "description": "The uuid of Tungsten-Fabric tag", "length": 255, - "name": "networkuuid", + "name": "taguuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "The uuid of Tungsten-Fabric Instance", "length": 255, "name": "vmuuid", "required": false, @@ -86468,80 +86550,88 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "List by keyword", "length": 255, - "name": "applicationpolicysetuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "The ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "The uuid of Tungsten-Fabric Network", + "length": 255, + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "The uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "keyword", + "name": "applicationpolicysetuuid", "required": false, "type": "string" } ], "related": "applyTungstenFabricTag", "response": [ - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "List Tungsten-Fabric network", + "name": "network", "type": "list" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "List Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "List Tungsten-Fabric Instance", + "name": "vm", "type": "list" }, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "List Tungsten-Fabric NIC", + "name": "nic", "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" } ] }, @@ -86551,18 +86641,25 @@ "name": "importLdapUsers", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "timezone", + "name": "accounttype", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -86572,37 +86669,31 @@ "type": "integer" }, { - "description": "details for account used to store specific parameters", + "description": "Details for account used to store specific parameters", "length": 255, "name": "accountdetails", "required": false, "type": "map" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "group", + "name": "timezone", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "Creates the account under the specified role.", "length": 255, - "name": "keyword", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "", "length": 255, - "name": "accounttype", + "name": "pagesize", "required": false, "type": "integer" }, @@ -86615,55 +86706,49 @@ "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "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": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "group", "required": false, - "type": "uuid" + "type": "string" } ], "related": "searchLdap", "response": [ + {}, { "description": "The user's domain", "name": "domain", "type": "string" }, { - "description": "The user's email", - "name": "email", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The user's firstname", - "name": "firstname", + "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 user's firstname", + "name": "firstname", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's username", + "name": "username", "type": "string" }, { @@ -86671,7 +86756,12 @@ "name": "conflictingusersource", "type": "string" }, - {} + {}, + { + "description": "The user's lastname", + "name": "lastname", + "type": "string" + } ], "since": "4.3.0" }, @@ -86681,17 +86771,17 @@ "name": "moveDomain", "params": [ { - "description": "The ID of the new parent domain of the domain to be moved.", + "description": "The ID of the domain to be moved.", "length": 255, - "name": "parentdomainid", + "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "The ID of the domain to be moved.", + "description": "The ID of the new parent domain of the domain to be moved.", "length": 255, - "name": "domainid", + "name": "parentdomainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" @@ -86700,340 +86790,340 @@ "related": "createDomain,listDomains,listDomains", "response": [ { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "The total number of CPU cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, - {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "Details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "The total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "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 that can be deployed by this domain", - "name": "vmlimit", + "description": "The total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the level of the domain", + "description": "The level of the domain", "name": "level", "type": "integer" }, { - "description": "the path of the domain", - "name": "path", + "description": "The domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of networks owned by domain", + "description": "The total number of Networks owned by domain", "name": "networktotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "The total number of CPU cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "The total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "The total number of Snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "The total number of Templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", - "type": "string" + "description": "The total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "The total number of Templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "The 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 object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "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 number of VPCs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "The total number of public IP addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "The total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "Whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "The total number of Instances that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "The total number of VPCs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" + "description": "The total number of projects available for administration by this domain", + "name": "projectavailable", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", - "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", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "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 allocated for this domain", - "name": "iptotal", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The total number of Instances deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "The total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, {}, { - "description": "the state of the domain", - "name": "state", + "description": "The total number of Instances available for this domain to acquire", + "name": "vmavailable", "type": "string" }, + {}, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "The total number of Snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "The total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "The total number of Networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "The total number of CPU cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "The state of the domain", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "The total number of Templates which can be created by this domain", + "name": "templatelimit", "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 vpcs owned by domain", - "name": "vpctotal", - "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 memory (in MB) the domain can own", + "name": "memorylimit", + "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 backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "The Network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "The total number of public IP addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "The total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "The total number of Snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "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 gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "The total number of VPCs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "The total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "The total number of public IP addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "The ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "The total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" } ], @@ -87045,7 +87135,15 @@ "name": "listNetworks", "params": [ { - "description": "the ID or VID of the network", + "description": "List objects by project; if projectid=-1 lists All Instances", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "The ID or VID of the network", "length": 255, "name": "vlan", "required": false, @@ -87053,200 +87151,163 @@ "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "Flag to display the resource icon for networks", "length": 255, "name": "showicon", "required": false, "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "type", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list networks by name", + "description": "List Networks by ACL (access control list) type. Supported values are Account and domain", "length": 255, - "name": "name", + "name": "acltype", "required": false, - "since": "4.22.0", "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": "displaynetwork", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "makes the API's response contains only the resource count", + "description": "The type of the Network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "isrecursive", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "uuid" }, { - "description": "List networks by VPC", + "description": "List Networks by ID", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "List Networks supporting certain services", "length": 255, - "name": "canusefordeploy", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "List by keyword", "length": 255, - "name": "acltype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the zone ID of the network", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "list networks by restartRequired", - "length": 255, - "name": "restartrequired", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "networkfilter", + "name": "account", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "list networks by ID", + "description": "The zone ID of the Network", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list networks by network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list networks supporting certain services", + "description": "True if Network is system, false otherwise", "length": 255, - "name": "supportedservices", + "name": "issystem", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "Type of the traffic", "length": 255, - "name": "specifyipranges", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if network is system, false otherwise", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "issystem", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "List by keyword", + "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": "keyword", + "name": "networkfilter", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the network belongs to VPC", + "description": "The network belongs to VPC", "length": 255, "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "type of the traffic", + "description": "list networks by name", "length": 255, - "name": "traffictype", + "name": "name", "required": false, + "since": "4.22.0", "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List networks by network offering ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "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 networks by associated networks. Only available if create a Shared 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": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "listall", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "boolean" }, { - "description": "list networks by physical network id", + "description": "List Networks by physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "listPhysicalNetworks,updatePhysicalNetwork", @@ -87261,427 +87322,313 @@ "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List networks by VPC", "length": 255, - "name": "tags", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "map" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "response": [ - {}, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "type": "uuid" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "List networks by restartRequired", + "length": 255, + "name": "restartrequired", + "required": false, "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "True if need to list only networks which support specifying IP ranges", + "length": 255, + "name": "specifyipranges", + "required": false, "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "list networks available for vm deployment", + "description": "List networks available for Instance deployment", + "length": 255, "name": "canusefordeploy", + "required": false, "type": "boolean" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "response": [ { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The project ID of the IP address", + "name": "projectid", "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 network's gateway", - "name": "gateway", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name of the address", + "description": "The project name of the address", "name": "project", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "The date this Network was created", + "name": "created", + "type": "date" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "Network offering ID the Network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The domain ID of the Network owner", + "name": "domainid", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "Path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "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": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, + {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The second IPv4 DNS for the Network", + "name": "dns2", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "the cidr of IPv6 network", + "description": "The CIDR of IPv6 Network", "name": "ip6cidr", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "ACL type - access type to the Network", + "name": "acltype", "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 Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The internet protocol of Network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "True if Network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "The ID of the Network", + "name": "id", "type": "string" }, { - "description": "the list of services", + "description": "The list of services", "name": "service", "response": [ { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "The list of capabilities", + "name": "capability", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "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 provider name", + "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": "services for this provider", + "description": "Services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", + "description": "True if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "UUID of the Network provider", + "name": "id", "type": "string" } ], @@ -87691,119 +87638,262 @@ "type": "list" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "The list of resource tags associated with Network", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The displaytext of the Network", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "List Networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The type of the Network", + "name": "type", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The details of the Network", + "name": "details", + "type": "map" + }, + { + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "ACL name associated with the VPC Network", + "name": "aclname", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "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": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "True if Network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "True if Network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "VPC the Network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "The Network's gateway", + "name": "gateway", + "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": "The name of the zone the Network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "True if Network supports specifying IP ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "The Network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "The first IPv4 DNS for the Network", + "name": "dns1", + "type": "string" + }, + { + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "AS NUMBER", "name": "asnumber", "type": "long" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "True if guest Network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "State of the Network", + "name": "state", + "type": "string" } ] }, { - "description": "Releases an IP address from the account.", + "description": "Releases an IP address from the Account.", "isasync": false, "name": "releaseIpAddress", "params": [ { - "description": "the ID of the public IP address to release", + "description": "The ID of the public IP address to release", "length": 255, "name": "id", "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -87812,27 +87902,27 @@ } ], "response": [ + {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "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" @@ -87882,28 +87972,28 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.16.0.0" }, @@ -87930,41 +88020,41 @@ "related": "listOsCategories", "response": [ {}, - {}, - { - "description": "the ID of the OS category", - "name": "id", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, + { + "description": "The name of the OS category", + "name": "name", + "type": "string" + }, { "description": "Date when the OS category was created.", "name": "created", "type": "date" }, { - "description": "the name of the OS category", - "name": "name", + "description": "The ID of the OS category", + "name": "id", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "Whether the OS category is featured", "name": "isfeatured", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting 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.21.0" @@ -87975,15 +88065,15 @@ "name": "updateFirewallRule", "params": [ { - "description": "the ID of the firewall rule", + "description": "The ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -87991,7 +88081,7 @@ "type": "boolean" }, { - "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, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, "name": "customid", "required": false, @@ -88002,149 +88092,149 @@ "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "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 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" }, { - "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 from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The Network ID of the firewall rule", + "name": "networkid", "type": "string" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "The traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the protocol of the firewall rule", + "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 ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "The public IP address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "Type of the ICMP message being sent", "name": "icmptype", "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": "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", + "description": "The starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, + {}, + {}, { - "description": "error code for this icmp message", - "name": "icmpcode", + "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 ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", + "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", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The 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", + "description": "The public IP address ID for the firewall rule", "name": "ipaddressid", "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -88155,21 +88245,21 @@ "params": [], "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": "is quota service enabled", + "description": "Is quota service enabled", "name": "isenabled", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ], @@ -88191,39 +88281,39 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "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.19.0" }, { - "description": "Lists all quota email templates", + "description": "Lists all quota email Templates", "isasync": false, "name": "quotaEmailTemplateList", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -88244,13 +88334,18 @@ { "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", + "type": "string" + }, { "description": "The quota email template subject", "name": "templatesubject", @@ -88262,32 +88357,27 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Template type", - "name": "templatetype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "The quota email template content", "name": "templatebody", "type": "string" }, {}, + {}, { "description": "Last date/time when template was updated", "name": "last_updated", "type": "date" }, - {} + { + "description": "Template type", + "name": "templatetype", + "type": "string" + } ], "since": "4.7.0" }, @@ -88296,21 +88386,6 @@ "isasync": true, "name": "createBgpPeer", "params": [ - { - "description": "domain ID of the account owning the Bgp Peer", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - }, { "description": "The IPv4 address of the Bgp Peer.", "length": 255, @@ -88326,26 +88401,26 @@ "type": "string" }, { - "description": "account who will own the Bgp Peer", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "account", + "name": "password", "required": false, "type": "string" }, { - "description": "UUID of the zone which the Bgp Peer belongs to.", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { - "description": "The password of the Bgp Peer.", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "password", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "project who will own the Bgp Peer", @@ -88356,95 +88431,110 @@ "type": "uuid" }, { - "description": "BGP peer details in key/value pairs.", + "description": "UUID of the zone which the Bgp Peer belongs to.", "length": 255, - "name": "details", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": true, + "type": "long" + }, + { + "description": "account who will own the Bgp Peer", + "length": 255, + "name": "account", "required": false, - "type": "map" + "type": "string" } ], "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "password of bgp peer", - "name": "password", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, - {}, - {}, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, + {}, { "description": "the account of the bgp peer", "name": "account", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" } ], @@ -88456,7 +88546,7 @@ "name": "listHypervisors", "params": [ { - "description": "the zone id for listing hypervisors.", + "description": "The zone id for listing hypervisors.", "length": 255, "name": "zoneid", "related": "listZones", @@ -88466,22 +88556,22 @@ ], "related": "", "response": [ - {}, { - "description": "Hypervisor 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Hypervisor name", + "name": "name", + "type": "string" } ] }, @@ -88490,14 +88580,6 @@ "isasync": true, "name": "dedicateBgpPeer", "params": [ - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" - }, { "description": "account who will own the Bgp Peer", "length": 255, @@ -88520,65 +88602,82 @@ "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" } ], "related": "listBgpPeers,releaseBgpPeer", "response": [ { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "password of bgp peer", - "name": "password", + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "id of the bgp peer", "name": "id", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { @@ -88587,20 +88686,11 @@ "type": "date" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, + {}, { "description": "the domain name of the bgp peer", "name": "domain", @@ -88615,40 +88705,32 @@ "name": "listHostsMetrics", "params": [ { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "the host version", "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", - "length": 255, - "name": "resourcestate", + "name": "version", "required": false, + "since": "4.20.3", "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "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": "clusterid", - "related": "addCluster,updateCluster", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "The state of the host", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the host", + "description": "The ID of the host", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, @@ -88668,40 +88750,35 @@ "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "Hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "Comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "hahost", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the Pod ID for the host", + "description": "the id of the management server", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "managementserverid", + "related": "listManagementServers", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "the host type", + "description": "The Zone ID for the host", "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "CPU Arch of the host", @@ -88712,189 +88789,196 @@ "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "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": "outofbandmanagementenabled", + "name": "resourcestate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the id of the management server", + "description": "The Pod ID for the host", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "since": "4.21.0", "type": "uuid" }, { - "description": "the state of the host", + "description": "Lists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instance", "length": 255, - "name": "state", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the host", + "description": "The name of the host", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "List hosts for which out-of-band management is enabled", "length": 255, - "name": "keyword", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the id of the host", + "description": "", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,reconnectHost", + "name": "page", "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "type": "integer" + }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "description": "If true, list only hosts dedicated to HA", + "length": 255, "name": "hahost", + "required": false, "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "Lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The host type", + "length": 255, + "name": "type", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "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", + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "The admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "Memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "The state of the host", + "name": "state", + "type": "status" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "CPU allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "Memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "CPU usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, + {}, { - "description": "network read in GiB", - "name": "networkread", + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "The last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { @@ -88903,180 +88987,194 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "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 total memory capacity in GiB", - "name": "memorytotalgb", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "The number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "Out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "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 CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "The total memory allocated in GiB", + "name": "memoryallocatedgb", + "type": "string" }, { - "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", + "type": "date" + }, + { + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the CPU number of the host", + "description": "The CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "The Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "Memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "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": "Capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "CPU usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, - {}, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "The host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "The total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "The outgoing Network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "The OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "The last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The amount of the host's CPU currently allocated", + "name": "cpuallocated", "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 Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "Network read in GiB", + "name": "networkread", + "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 number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "Instances on the host", + "name": "instances", + "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "Events available for the host", + "name": "events", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "CPU allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -89089,48 +89187,48 @@ "type": "string" }, { - "description": "the list of enabled vGPUs", + "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", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "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 Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", + "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 Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" } ], "type": "list" @@ -89139,23 +89237,8 @@ "type": "list" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "True if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { @@ -89164,144 +89247,159 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", + "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": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "The amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "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": "events available for the host", - "name": "events", + "description": "Network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "The amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "The ID of the host", + "name": "id", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "The name of the host", + "name": "name", "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 host hypervisor", - "name": "hypervisor", + "description": "The total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "Memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "The host type", + "name": "type", + "type": "type" }, { - "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", - "type": "string" + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "The memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "Comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" } ], "since": "4.9.3" @@ -89312,7 +89410,7 @@ "name": "releaseDedicatedPod", "params": [ { - "description": "the ID of the Pod", + "description": "The ID of the Pod", "length": 255, "name": "podid", "related": "listPods,createManagementNetworkIpRange", @@ -89321,29 +89419,100 @@ } ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" + } + ] + }, + { + "description": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "The UUID of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown", + "response": [ + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "The id of the management server", + "name": "managementserverid", "type": "string" }, - {}, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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 management server", + "name": "state", + "type": "state" } - ] + ], + "since": "4.19.0" }, { "description": "Lists affinity groups", @@ -89351,248 +89520,184 @@ "name": "listAffinityGroups", "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists affinity groups by name", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list the affinity group by the ID provided", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "Lists affinity groups by Instance ID", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Lists affinity groups by name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "Lists affinity groups by type", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List the affinity group by the ID provided", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "lists affinity groups by type", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "createAffinityGroup", "response": [ { - "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", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, - {}, { - "description": "the type of the affinity group", - "name": "type", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "The project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "The account owning the affinity group", "name": "account", "type": "string" }, + {}, + {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, - {}, { - "description": "virtual machine IDs associated with this affinity group", + "description": "Instance 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", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", + "description": "The project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Cancels a triggered shutdown", + "description": "Register a public key in a keypair under a certain name", "isasync": false, - "name": "cancelShutdown", + "name": "registerSSHKeyPair", "params": [ { - "description": "the id of the management server", + "description": "Name of the keypair", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "name", "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown,readyForShutdown", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "type": "boolean" - }, - { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, - { - "description": "The number of host agents this management server is responsible for", - "name": "agentscount", - "type": "long" - }, - { - "description": "The id of the management server", - "name": "managementserverid", "type": "string" }, { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" - }, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Register a public key in a keypair under a certain name", - "isasync": false, - "name": "registerSSHKeyPair", - "params": [ - { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains", @@ -89600,83 +89705,71 @@ "type": "uuid" }, { - "description": "Name of the keypair", + "description": "An optional project for the SSH key", "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, - "type": "string" + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "An optional Account for the SSH key. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, + "type": "string" } ], "related": "listSSHKeyPairs", "response": [ - { - "description": "the owner of the keypair", - "name": "account", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", + "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": "The owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "The domain id of the keypair owner", + "name": "domainid", "type": "string" }, - {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "The domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "The project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "The project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "Name of the keypair", @@ -89684,9 +89777,14 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "ID of the SSH keypair", + "name": "id", + "type": "string" } ] }, @@ -89712,63 +89810,63 @@ ], "related": "", "response": [ + { + "description": "The validated activation rule.", + "name": "activationrule", + "type": "string" + }, { "description": "Whether the activation rule is valid.", "name": "isvalid", "type": "boolean" }, { - "description": "The reason whether the activation rule is valid or not.", - "name": "message", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The validated activation rule.", - "name": "activationrule", + "description": "The Quota usage type used to validate the activation rule.", + "name": "quotatype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "The Quota usage type used to validate the activation rule.", - "name": "quotatype", + "description": "The reason whether the activation rule is valid or not.", + "name": "message", "type": "string" } ], "since": "4.20.0" }, { - "description": "Reserve a public IP to an account.", + "description": "Reserve a public IP to an Account.", "isasync": false, "name": "reserveIpAddress", "params": [ { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "The ID of the domain to reserve with this IP address", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the project to reserve with this IP address", + "description": "The Account to reserve with this IP address", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the public IP address to reserve", + "description": "The ID of the public IP address to reserve", "length": 255, "name": "id", "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -89776,282 +89874,282 @@ "type": "uuid" }, { - "description": "the ID of the domain to reserve with this IP address", + "description": "The ID of the project to reserve with this IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "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" } ], "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "public IP address id", - "name": "id", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "Instance display name the IP address is assigned to (not null only for static NAT IP)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "is public IP portable across the zones", + "description": "Is public IP portable across the zones", "name": "isportable", "type": "boolean" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "Is public IP for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "Date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the name of the Network where ip belongs to", + "description": "The name of the Network where IP belongs to", "name": "networkname", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "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": "Public IP address ID", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if this IP is for static NAT, false otherwise", + "name": "isstaticnat", "type": "boolean" }, + {}, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "The VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "The name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 range is dedicated for System VMs", - "name": "forsystemvms", + "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": "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 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": "VPC ID the IP belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "Public IP address", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "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": "The Account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", + "description": "The virtual Network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "Instance (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": "The ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "The domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", + "description": "Instance type the IP address is assigned to", "name": "virtualmachinetype", "type": "string" }, - {}, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with ip address", + "description": "The list of resource tags associated with IP address", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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 project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", - "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 (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "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 the IP address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", + "description": "The name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - } + "description": "Instance id the IP address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + {} ], "since": "4.17" }, @@ -90061,57 +90159,57 @@ "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": "Start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, "name": "startdate", "required": false, "type": "date" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "Delete by event type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "End date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, "name": "enddate", "required": false, "type": "date" }, { - "description": "the IDs of the events", + "description": "The IDs of the events", "length": 255, "name": "ids", "related": "", "required": false, "type": "list" - }, - { - "description": "delete by event type", - "length": 255, - "name": "type", - "required": false, - "type": "string" } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "true if operation is executed successfully", + "description": "True 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" } ] }, @@ -90121,7 +90219,7 @@ "name": "deleteIso", "params": [ { - "description": "the ID of the ISO file", + "description": "The ID of the ISO file", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -90129,7 +90227,7 @@ "type": "uuid" }, { - "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", + "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": "listZones", @@ -90139,27 +90237,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "true if operation is executed successfully", + "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" - }, - {} + } ] }, { @@ -90168,21 +90266,15 @@ "name": "listVPCOfferings", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list VPC offerings by state", + "description": "List VPC offerings by ID", "length": 255, - "name": "state", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "id of zone VPC offering is associated with", + "description": "ID of zone VPC offering is associated with", "length": 255, "name": "zoneid", "related": "listZones", @@ -90191,19 +90283,18 @@ "type": "uuid" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "List VPC offerings by state", "length": 255, - "name": "isdefault", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list VPC offerings by id", + "description": "", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -90213,181 +90304,212 @@ "type": "string" }, { - "description": "list VPC offerings supporting certain services", + "description": "", "length": 255, - "name": "supportedservices", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "list VPC offerings by name", + "description": "List VPC offerings by display text", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "list VPC offerings by display text", + "description": "List VPC offerings supporting certain services", "length": 255, - "name": "displaytext", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "List VPC offerings by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "List VPC offerings available for VPC creation in specific domain", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains", "required": false, "since": "4.18", "type": "uuid" + }, + { + "description": "True if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" } ], "related": "updateVPCOffering", "response": [ - {}, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "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": "True if VPC offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, - {}, { - "description": "the id of the vpc offering", - "name": "id", + "description": "The internet protocol of the VPC offering", + "name": "internetprotocol", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "The ID of the VPC offering", + "name": "id", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" + "description": "The date this VPC offering was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the VPC offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "description": "The routing mode for the network offering, supported types are Static or Dynamic.", "name": "routingmode", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "Indicated if the offering can support region level VPC", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "An alternate display text of the VPC offering.", + "name": "displaytext", + "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", + "description": "True if VPC offering is default, false otherwise", "name": "isdefault", "type": "boolean" }, + {}, + { + "description": "True if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, { - "description": "the name of the vpc offering", + "description": "The name of the VPC offering", "name": "name", "type": "string" }, { - "description": "the list of supported services", + "description": "Indicates if the VPC offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the list of capabilities", + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", + "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", + "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", + "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", + "description": "Services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "UUID of the Network provider", + "name": "id", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "The provider name", + "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -90396,35 +90518,11 @@ "type": "list" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "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", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, - { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - } + {} ] }, { @@ -90442,23 +90540,23 @@ ], "related": "", "response": [ - { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" - }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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" + }, + {} ] }, { @@ -90467,22 +90565,28 @@ "name": "uploadVolume", "params": [ { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "description": "Image store uuid", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "imagestoreuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the volume", + "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 format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", + "description": "An optional domainId. If the Account parameter is used, domainId must also be used. If Account is NOT provided then volume will be assigned to the caller Account and domain.", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains", @@ -90490,123 +90594,127 @@ "type": "uuid" }, { - "description": "Upload volume for the project", + "description": "The ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "diskofferingid", + "related": "", "required": false, "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": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "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, - "type": "string" - }, - { - "description": "an optional accountName. Must be used with domainId.", + "description": "Upload volume for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Image store uuid", + "description": "The ID of the zone the volume is to be hosted on", "length": 255, - "name": "imagestoreuuid", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "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": "format", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the ID of the zone the volume is to be hosted on", + "description": "The name of the volume", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk volume", + "description": "Name of the disk volume", "name": "name", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, {}, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -90615,33 +90723,43 @@ "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "state of the virtual machine", + "description": "State of the Instance", "name": "vmstate", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "Pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { @@ -90650,322 +90768,302 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "The path of the volume", + "name": "path", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "Max IOPS of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the bytes allocated", - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "size of the disk volume", - "name": "size", + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "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 read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Display name of the Instance", + "name": "vmdisplayname", "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "Size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "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 name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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": "the chain info of the volume", - "name": "chaininfo", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Name of the Instance", + "name": "vmname", "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": "the path of the volume", - "name": "path", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "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": "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 status of the volume", - "name": "status", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 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 bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" } ] }, @@ -90975,118 +91073,118 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface user", + "description": "The host management interface user", "length": 255, "name": "username", "required": true, "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "The ID of the host", "length": 255, - "name": "driver", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface port", + "description": "The host management interface driver, for example: ipmitool", "length": 255, - "name": "port", + "name": "driver", "required": true, "type": "string" }, { - "description": "the host management interface password", + "description": "The host management interface password", "length": 255, "name": "password", "required": true, "type": "string" }, { - "description": "the host management interface IP address", + "description": "The host management interface IP address", "length": 255, "name": "address", "required": true, "type": "string" }, { - "description": "the ID of the host", + "description": "The host management interface port", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "port", "required": true, - "type": "uuid" + "type": "string" } ], "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "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 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 out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "The ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "True if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "The out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The operation result description", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", + "description": "The out-of-band management action (if issued)", "name": "action", "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the operation result", + "description": "The operation result", "name": "status", "type": "boolean" - } + }, + { + "description": "The out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + {} ], "since": "4.9.0" }, @@ -91095,13 +91193,6 @@ "isasync": false, "name": "listStorageTags", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -91115,33 +91206,40 @@ "name": "page", "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 UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the storage tag", + "description": "The ID of the storage tag", "name": "id", "type": "string" }, + {}, { - "description": "the name of the storage tag", + "description": "The name of the storage tag", "name": "name", "type": "string" }, { - "description": "the pool ID of the storage tag", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The pool ID of the storage tag", "name": "poolid", "type": "long" }, @@ -91149,104 +91247,78 @@ ] }, { - "description": "Delete VM Schedule.", - "isasync": false, - "name": "deleteVMSchedule", + "description": "Creates a IPv4 subnet for guest networks.", + "isasync": true, + "name": "createIpv4SubnetForGuestNetwork", "params": [ { - "description": "IDs of VM schedule", + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, - "name": "ids", - "related": "", + "name": "cidrsize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "ID of VM", + "description": "The CIDR of this Ipv4 subnet.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" + "name": "subnet", + "required": false, + "type": "string" }, { - "description": "ID of VM schedule", + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "id", - "related": "", - "required": false, + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": true, "type": "uuid" } ], + "related": "", "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates a IPv4 subnet for guest networks.", - "isasync": true, - "name": "createIpv4SubnetForGuestNetwork", - "params": [ + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + }, { - "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", - "length": 255, + "description": "id of the data center IPv4 subnet", "name": "parentid", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The CIDR of this Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", - "length": 255, - "name": "cidrsize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { @@ -91255,18 +91327,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, + {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { @@ -91275,57 +91348,82 @@ "type": "date" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, + {}, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Delete Instance Schedule.", + "isasync": false, + "name": "deleteVMSchedule", + "params": [ + { + "description": "ID of Instance", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, - {}, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", - "type": "string" + "description": "IDs of Instance schedule", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" }, - {}, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "ID of Instance schedule", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.20.0" + "since": "4.19.0" }, { - "description": "List template visibility and all accounts that have permissions to view this template.", + "description": "List Template visibility and all accounts that have permissions to view this Template.", "isasync": false, "name": "listTemplatePermissions", "params": [ { - "description": "the template ID", + "description": "The Template ID", "length": 255, "name": "id", "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", @@ -91336,40 +91434,40 @@ "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the list of projects the template is available for", - "name": "projectids", + "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 list of Accounts the Template is available for", + "name": "account", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, { - "description": "the 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 template ID", + "description": "The Template ID", "name": "id", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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" }, {} ] @@ -91380,127 +91478,127 @@ "name": "listAnnotations", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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": "The entity type", "length": 255, "name": "entitytype", "required": false, "type": "string" }, { - "description": "the id of the annotation", + "description": "Optional: The ID of the user of the annotation", "length": 255, - "name": "id", + "name": "userid", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "annotationfilter", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "string" }, { - "description": "optional: the id of the user of the annotation", + "description": "The ID of the entity for which to show annotations", "length": 255, - "name": "userid", + "name": "entityid", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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": "page", "required": false, - "since": "4.16.0", - "type": "string" + "type": "integer" } ], "related": "addAnnotation", "response": [ { - "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 UUID of the User that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "The username of the User that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the type of the annotated entity", + "description": "The type of the annotated entity", "name": "entitytype", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "The creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "The removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "The UUID of the annotation", + "name": "id", "type": "string" }, + {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "The name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "The contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "The UUID of the entity to which this annotation pertains", + "name": "entityid", "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", + "type": "boolean" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -91511,14 +91609,21 @@ "name": "addSwift", "params": [ { - "description": "the username for swift", + "description": "The account for swift", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The username for swift", "length": 255, "name": "username", "required": false, "type": "string" }, { - "description": "the URL for swift", + "description": "The URL for swift", "length": 255, "name": "url", "required": true, @@ -91530,88 +91635,81 @@ "name": "key", "required": false, "type": "string" - }, - { - "description": "the account for swift", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "The scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the UUID of the latest async job acting on this object", + "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 url of the image store", - "name": "url", + "description": "The name of the image store", + "name": "name", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "The ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "The URL of the image store", + "name": "url", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "The protocol of the image store", + "name": "protocol", "type": "string" }, + {}, + {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "Defines if store is read-only", + "name": "readonly", + "type": "boolean" }, - {}, { - "description": "the Zone ID of the image store", + "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 provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "The host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the total disk size of the host", + "description": "The total disk size of the host", "name": "disksizetotal", "type": "long" + }, + { + "description": "The Zone name of the image store", + "name": "zonename", + "type": "string" } ], "since": "3.0.0" @@ -91622,11 +91720,12 @@ "name": "updateVgpuProfile", "params": [ { - "description": "the maximum X resolution", + "description": "the ID of the vGPU profile", "length": 255, - "name": "maxresolutionx", - "required": false, - "type": "long" + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile", + "required": true, + "type": "uuid" }, { "description": "the name of the vGPU profile", @@ -91636,40 +91735,39 @@ "type": "string" }, { - "description": "the maximum number of vGPUs per physical GPU", + "description": "the description of the vGPU profile", "length": 255, - "name": "maxvgpuperphysicalgpu", + "name": "description", "required": false, - "type": "long" + "type": "string" }, { - "description": "the maximum number of display heads", + "description": "the maximum X resolution", "length": 255, - "name": "maxheads", + "name": "maxresolutionx", "required": false, "type": "long" }, { - "description": "the ID of the vGPU profile", + "description": "the maximum number of vGPUs per physical GPU", "length": 255, - "name": "id", - "related": "createVgpuProfile,updateVgpuProfile", - "required": true, - "type": "uuid" + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" }, { - "description": "the video RAM size in MB", + "description": "the maximum number of display heads", "length": 255, - "name": "videoram", + "name": "maxheads", "required": false, "type": "long" }, { - "description": "the description of the vGPU profile", + "description": "the video RAM size in MB", "length": 255, - "name": "description", + "name": "videoram", "required": false, - "type": "string" + "type": "long" }, { "description": "the maximum Y resolution", @@ -91681,61 +91779,66 @@ ], "related": "createVgpuProfile", "response": [ + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, { "description": "the vendor name of the GPU card", "name": "vendorname", "type": "string" }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, { "description": "the maximum Y resolution", "name": "maxresolutiony", "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the vGPU profile", - "name": "gpucardname", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, - {}, { "description": "the vendor ID of the GPU card", "name": "vendorid", "type": "string" }, { - "description": "the description of the vGPU profile", - "name": "description", - "type": "string" + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "the device ID of the GPU card", - "name": "deviceid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "the maximum number of vGPUs per physical GPU", - "name": "maxvgpuperphysicalgpu", - "type": "long" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the ID of the GPU card", @@ -91754,59 +91857,48 @@ "type": "long" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the display name of the GPU card", + "name": "name", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.21.0" }, { - "description": "Lists snapshot policies.", + "description": "Lists Snapshot policies.", "isasync": false, "name": "listSnapshotPolicies", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "The ID of the Snapshot policy", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -91816,35 +91908,41 @@ "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "", @@ -91856,157 +91954,148 @@ ], "related": "updateSnapshotPolicy", "response": [ - {}, { - "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", + "type": "string" }, { - "description": "The list of pools in which snapshot backup is scheduled", - "name": "storage", - "type": "set" + "description": "The time zone of the Snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "is this policy for display to the regular user", + "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": "the ID of the disk volume", + "description": "The interval type of the Snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "The ID of the disk volume", "name": "volumeid", "type": "string" }, + {}, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Time the Snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "the name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "maximum number of snapshots retained", + "description": "Maximum number of Snapshots retained", "name": "maxsnaps", "type": "int" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - {}, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, { - "description": "Update site to site vpn customer gateway", + "description": "Update site to site VPN customer gateway", "isasync": true, "name": "updateVpnCustomerGateway", "params": [ { - "description": "id of customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "id", - "related": "updateVpnCustomerGateway", + "name": "ikepolicy", "required": true, - "type": "uuid" - }, - { - "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" + "type": "string" }, { "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", @@ -92023,19 +92112,11 @@ "type": "string" }, { - "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": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "The Account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "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", @@ -92046,39 +92127,42 @@ "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "dpd", + "name": "splitconnections", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", + "description": "ID of customer gateway", "length": 255, - "name": "gateway", + "name": "id", + "related": "updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "Guest CIDR of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" + "name": "cidrlist", + "required": true, + "type": "string" }, { - "description": "name of this customer gateway", + "description": "Public IP address id of the customer gateway", "length": 255, - "name": "name", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "The domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.", "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", @@ -92088,188 +92172,188 @@ "type": "long" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "account", + "name": "forceencap", + "required": false, + "type": "boolean" + }, + { + "description": "Name of this customer gateway", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "ikepolicy", + "name": "dpd", + "required": false, + "type": "boolean" + }, + { + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", "required": true, "type": "string" } ], "related": "", "response": [ - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, + {}, { "description": "IPsec policy of customer gateway", "name": "esppolicy", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "Guest IP of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "The domain ID of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "If Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, { "description": "Lifetime of ESP SA of customer gateway", "name": "esplifetime", "type": "long" }, { - "description": "if DPD is enabled for customer gateway", + "description": "If DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "The owner", + "name": "account", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "The project name", + "name": "project", "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "Public IP address ID of the customer gateway", "name": "gateway", "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", + "description": "The date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "The project ID", + "name": "projectid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "The VPN gateway ID", + "name": "id", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, - {}, { - "description": "the domain name of the owner", + "description": "The domain name of the owner", "name": "domain", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.", "name": "splitconnections", "type": "boolean" } ] }, { - "description": "apply Tungsten-Fabric tag", + "description": "Apply Tungsten-Fabric tag", "isasync": true, "name": "applyTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", + "description": "The UUID of Tungsten-Fabric policy", "length": 255, "name": "policyuuid", "required": false, "type": "string" }, { - "description": "the uuid of vms", + "description": "The UUID of Tungsten-Fabric application policy set", "length": 255, - "name": "vmuuid", + "name": "applicationpolicysetuuid", "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, "type": "string" }, { - "description": "the uuid of nics", + "description": "The UUID of Instances", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -92277,66 +92361,80 @@ "type": "uuid" }, { - "description": "the uuid of networks", + "description": "The UUID of networks", "length": 255, "name": "networkuuid", "required": false, "type": "list" + }, + { + "description": "The UUID of NICs", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "list" + }, + { + "description": "The UUID of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "List Tungsten-Fabric NIC", + "name": "nic", "type": "list" }, {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "List Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "list Tungsten-Fabric network", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "List Tungsten-Fabric network", "name": "network", "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "List Tungsten-Fabric Instance", + "name": "vm", + "type": "list" }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -92346,16 +92444,24 @@ "name": "updateObjectStoragePool", "params": [ { - "description": "the name for the object store", + "description": "the url for the object store", "length": 255, - "name": "name", + "name": "url", "required": false, "type": "string" }, { - "description": "the url for the object store", + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", "length": 255, - "name": "url", + "name": "size", + "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -92366,68 +92472,60 @@ "related": "addObjectStoragePool,updateObjectStoragePool", "required": true, "type": "uuid" - }, - { - "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", - "length": 255, - "name": "size", - "required": false, - "since": "4.21", - "type": "long" } ], "related": "addObjectStoragePool", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" }, + {}, { - "description": "the name of the object store", - "name": "name", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the name of the object store", + "name": "name", + "type": "string" }, { - "description": "the url of the object store", - "name": "url", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the allocated size of the object store", - "name": "storageallocated", + "description": "the total size of the object store", + "name": "storagetotal", "type": "long" }, { - "description": "the ID of the object store", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the provider name of the object store", + "name": "providername", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the url of the object store", + "name": "url", + "type": "string" }, - {}, - {}, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" } ], @@ -92439,11 +92537,11 @@ "name": "registerExtension", "params": [ { - "description": "ID of the resource to register the extension with", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", "length": 255, - "name": "resourceid", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { "description": "ID of the extension", @@ -92461,120 +92559,125 @@ "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "description": "ID of the resource to register the extension with", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "resourceid", + "required": true, + "type": "string" } ], "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" + "description": "Name of the extension", + "name": "name", + "type": "string" }, { - "description": "The details of the extension", - "name": "details", - "type": "map" + "description": "ID of the extension", + "name": "id", + "type": "string" }, { - "description": "The state of the extension", - "name": "state", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "ID of the extension", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the extension", - "name": "name", + "description": "Description of the extension", + "name": "description", "type": "string" }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ - { - "description": "the details of the resource map", - "name": "details", - "type": "map" - }, { "description": "ID of the resource associated with the extension", "name": "id", "type": "string" }, - { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" - }, { "description": "Type of the resource", "name": "type", "type": "string" }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, { "description": "Name of the resource associated with this mapping", "name": "name", "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" } ], "type": "list" }, { - "description": "Creation timestamp of the extension", - "name": "created", + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", "type": "date" }, - { - "description": "Description of the extension", - "name": "description", - "type": "string" - }, { "description": "Type of the extension", "name": "type", "type": "string" }, - {}, - { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, { "description": "The path of the entry point fo the extension", "name": "path", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", + "type": "string" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + {}, + { + "description": "The state of the extension", + "name": "state", "type": "string" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" } ], "since": "4.21.0" }, { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "description": "This deprecated function used to lock an Account. Look for the API DisableAccount instead", "isasync": false, "name": "lockAccount", "params": [ @@ -92586,7 +92689,7 @@ "type": "string" }, { - "description": "Locks the specified account on this domain.", + "description": "Locks the specified Account on this domain.", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains", @@ -92597,307 +92700,185 @@ "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the name of the role", + "description": "The name of the role", "name": "rolename", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "The total 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": "integer" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "The total number of projects the Account can own", + "name": "projectlimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "The total volume available for this Account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "The total number of VPCs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "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 cpu cores the account can own", - "name": "cpulimit", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "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) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", + "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user firstname", - "name": "firstname", - "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 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 lastname", - "name": "lastname", - "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 user email address", - "name": "email", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - } - ], - "type": "list" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", + "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "The total number of VPCs the Account can own", + "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "The state of the account", + "name": "state", + "type": "string" }, { - "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 number of templates available to be created by this account", - "name": "templateavailable", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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 primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this account", + "description": "The total number of Snapshots which can be stored by this Account", "name": "snapshotlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "The total number of Instances running for this Account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "The name of the Account", + "name": "name", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -92905,89 +92886,85 @@ "type": "resourceiconresponse" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", + "description": "The total number of Templates which can be created by this Account", "name": "templatelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "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 total number of vpcs the account can own", - "name": "vpclimit", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", + "type": "string" }, + {}, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "The total number of Networks the Account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "The total number of Networks available to be created for this Account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "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 date when this account was created", + "name": "created", + "type": "date" }, { "description": "the total number of backups available to this account", @@ -92995,124 +92972,250 @@ "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "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) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, - {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" + "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 type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "The API key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "The user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "The Account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "The user ID", + "name": "id", + "type": "string" + }, + { + "description": "The user email address", + "name": "email", + "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": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "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 name", + "name": "username", + "type": "string" + }, + { + "description": "The secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "The domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "The name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "The timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" + }, + { + "description": "The domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "True if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "The total number of CPU cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", + "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", + "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) the account can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", - "type": "string" + "description": "The total number of Templates which have been created by this Account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The default zone of the Account", + "name": "defaultzoneid", + "type": "string" }, { - "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": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "The ID of the Account", + "name": "id", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "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 allocated for this Account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" } ] @@ -93123,7 +93226,7 @@ "name": "stopRouter", "params": [ { - "description": "the ID of the router", + "description": "The ID of the router", "length": 255, "name": "id", "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", @@ -93131,7 +93234,7 @@ "type": "uuid" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.", "length": 255, "name": "forced", "required": false, @@ -93141,354 +93244,312 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The version of Template", + "name": "version", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "The version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "The domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the list of nics associated with the router", + "description": "The list of NICs associated with the router", "name": "nic", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "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": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the netmask of the nic", + "description": "The netmask of the NIC", "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The ID of the corresponding Network", + "name": "networkid", "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 ID of the nic", - "name": "id", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "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 ID of the corresponding network", - "name": "networkid", + "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 the NIC", + "name": "gateway", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "The name of the router", + "name": "name", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "The Pod name for the router", + "name": "podname", "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 if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "The second DNS for the router", + "name": "dns2", + "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "The guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, - {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "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 template ID for the router", - "name": "templateid", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "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 Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "The Pod ID for the router", + "name": "podid", "type": "string" }, + {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "The Template name for the router", + "name": "templatename", "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": "CPU arch of the router", @@ -93496,124 +93557,166 @@ "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "The project id of the IP address", + "name": "projectid", "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 date and time the router was created", + "name": "created", + "type": "date" + }, + { + "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 result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "The type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "The public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain associated with the router", + "description": "The domain associated with the router", "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "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", + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the id of the router", + "description": "The ID of the router", "name": "id", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "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" } ] @@ -93624,7 +93727,7 @@ "name": "deleteProjectInvitation", "params": [ { - "description": "id of the invitation", + "description": "ID of the invitation", "length": 255, "name": "id", "related": "", @@ -93633,46 +93736,38 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "3.0.0" }, { - "description": "create Tungsten-Fabric firewall policy", + "description": "Create Tungsten-Fabric firewall policy", "isasync": true, "name": "createTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "The UUID of Tungsten-Fabric application policy set", "length": 255, "name": "applicationpolicysetuuid", "required": false, @@ -93686,11 +93781,19 @@ "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall policy", + "description": "The sequence of Tungsten-Fabric firewall policy", "length": 255, "name": "sequence", "required": true, "type": "integer" + }, + { + "description": "The ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", @@ -93701,25 +93804,16 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "List Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, + {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, {}, { "description": "Tungsten-Fabric provider zone id", @@ -93727,11 +93821,20 @@ "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, - {} + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -93740,66 +93843,66 @@ "name": "updateRegion", "params": [ { - "description": "updates region with this end point", + "description": "Id of region to update", "length": 255, - "name": "endpoint", - "required": false, - "type": "string" + "name": "id", + "required": true, + "type": "integer" }, { - "description": "updates region with this name", + "description": "Updates region with this name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "Id of region to update", + "description": "Updates region with this end point", "length": 255, - "name": "id", - "required": true, - "type": "integer" + "name": "endpoint", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "description": "True if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, {}, { - "description": "the name of the region", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the region", + "description": "The ID of the region", "name": "id", "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", + "description": "True if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 end point of the region", + "name": "endpoint", + "type": "string" + } ] }, { @@ -93808,7 +93911,7 @@ "name": "deleteTrafficType", "params": [ { - "description": "traffic type id", + "description": "Traffic type ID", "length": 255, "name": "id", "related": "addTrafficType,updateTrafficType", @@ -93818,27 +93921,27 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "Any text associated with the 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", + "description": "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" }, @@ -93872,26 +93975,26 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "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.20.0" @@ -93901,14 +94004,6 @@ "isasync": false, "name": "listProjectRolePermissions", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project", "length": 255, @@ -93916,57 +94011,65 @@ "related": "createProject", "required": true, "type": "uuid" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "The ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the project role permission", - "name": "id", + "description": "The name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", + "description": "The ID of the project role to which the role permission belongs", "name": "projectroleid", "type": "string" }, { - "description": "the api name or wildcard rule", + "description": "The api name or wildcard rule", "name": "rule", "type": "string" }, - {}, - {}, { - "description": "the description of the role permission", + "description": "The description of the role permission", "name": "description", "type": "string" }, { - "description": "the ID of the project", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "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", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" - } + }, + {} ], "since": "4.15.0" }, @@ -93975,13 +94078,6 @@ "isasync": false, "name": "listLdapConfigurations", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, @@ -93991,17 +94087,23 @@ "type": "boolean" }, { - "description": "linked domain", + "description": "Port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "Hostname", "length": 255, - "name": "keyword", + "name": "hostname", "required": false, "type": "string" }, @@ -94014,23 +94116,24 @@ "type": "uuid" }, { - "description": "Port", + "description": "", "length": 255, - "name": "port", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "Linked domain", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Hostname", + "description": "List by keyword", "length": 255, - "name": "hostname", + "name": "keyword", "required": false, "type": "string" } @@ -94038,200 +94141,199 @@ "related": "addLdapConfiguration", "response": [ { - "description": "linked domain", + "description": "Linked domain", "name": "domainid", "type": "string" }, - {}, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the LDAP configuration", - "name": "id", + "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", + "description": "Port the LDAP server is running on", + "name": "port", + "type": "int" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the ID of the LDAP configuration", + "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" }, { - "description": "Creates a l2tp/ipsec remote access vpn", + "description": "Creates a l2tp/ipsec remote access VPN", "isasync": true, "name": "createRemoteAccessVpn", "params": [ { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "description": "If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, "name": "openfirewall", "required": false, "type": "boolean" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "An optional Account for the VPN. Must be used with domainId.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "type": "string" }, { - "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": "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": "an optional account for the VPN. Must be used with domainId.", + "description": "An optional field, whether to the display the VPN to the end User or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "Public IP address id of the VPN server", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], "related": "listRemoteAccessVpns", "response": [ { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the remote access vpn belongs", + "description": "Path of the domain to which the remote access VPN belongs", "name": "domainpath", "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 project id of the vpn", - "name": "projectid", + "description": "The IPSec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the range of ips to allocate to the clients", + "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 public IP address of the VPN server", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "The state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The 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 Account of the remote access VPN", + "name": "account", "type": "string" }, + {}, + {}, { - "description": "the public ip address of the vpn server", + "description": "The public IP address of the VPN server", "name": "publicip", "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 ipsec preshared key", - "name": "presharedkey", + "description": "The ID of the remote access VPN", + "name": "id", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "description": "Is VPN for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for an Instance. The Instance must be in a \"Stopped\" state for this command to take effect.", "isasync": false, "name": "changeServiceForVirtualMachine", "params": [ { - "description": "Verify OK to Shrink", + "description": "The service offering ID to apply to the Instance", "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" + "name": "serviceofferingid", + "related": "createServiceOffering,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", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "automigrate", + "name": "maxiops", "required": false, "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "maxiops", + "name": "details", "required": false, - "since": "4.17", - "type": "long" + "type": "map" }, { "description": "New minimum number of IOPS for the custom disk offering", @@ -94242,791 +94344,599 @@ "type": "long" }, { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "the service offering ID to apply to the virtual machine", + "description": "Verify OK to Shrink", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "details", + "name": "automigrate", "required": false, - "type": "map" + "since": "4.17", + "type": "boolean" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "ID of AutoScale VM group", + "description": "ID of AutoScale Instance group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "List of read-only Instance 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": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "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 key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "set" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the 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 count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", + "description": "The amount of the Instance's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The project name of the Instance", + "name": "project", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "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 number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain ID of the affinity group", + "description": "The domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the affinity group", + "description": "The ID of the security group", "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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 name of the affinity group", + "description": "The name of the security group", "name": "name", "type": "string" - } - ], - "type": "set" - }, - { - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "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 gpu card to which service offering is linked", - "name": "gpucardname", - "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": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ + }, { - "description": "the name of the security group", - "name": "name", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the security group", + "description": "The domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "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 egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the type of the ICMP message response", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", + "description": "The protocol of the security group rule", "name": "protocol", "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the list of ingress rules associated with the security group", + "description": "The list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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 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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", + "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", + "description": "The CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { @@ -95035,147 +94945,92 @@ "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "device ID of the root volume", + "description": "Device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "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", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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": "true if vm has delete protection.", - "name": "deleteprotection", - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -95184,244 +95039,497 @@ "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the 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 VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the 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", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, { "description": "MTU configured on the NIC", "name": "mtu", "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", + "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 corresponding Network", + "name": "networkid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The type of the NIC", + "name": "type", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" } ], "type": "set" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "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", + "description": "The date when this Instance was created", "name": "created", "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Vm details in key/value pairs.", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Instance name of the user Instance; 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 User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + {}, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "The ID of the domain in which the Instance exists", "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The vGPU type used by the Instance", "name": "vgpu", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "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 Instance", + "name": "affinitygroup", + "response": [ + { + "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": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { "description": "the maximum X resolution", "name": "maxresolutionx", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", "name": "networkkbsread", "type": "long" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" + }, + {}, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" } ] }, @@ -95431,14 +95539,14 @@ "name": "listGuestOsMapping", "params": [ { - "description": "", + "description": "List Guest OS mapping by hypervisor", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", + "description": "List mapping by Guest OS Type UUID", "length": 255, "name": "ostypeid", "related": "addGuestOs", @@ -95448,19 +95556,12 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, - "type": "string" - }, - { - "description": "list mapping by its UUID", + "description": "List mapping by its UUID", "length": 255, "name": "id", "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", @@ -95468,25 +95569,25 @@ "type": "uuid" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "List Guest OS mapping by OS display name", "length": 255, - "name": "hypervisor", + "name": "osdisplayname", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "List Guest OS mapping by OS mapping name with hypervisor", "length": 255, "name": "osnameforhypervisor", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by OS display name", + "description": "", "length": 255, - "name": "osdisplayname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -95494,114 +95595,113 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "List Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", + "length": 255, + "name": "hypervisorversion", + "required": false, + "type": "string" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ + {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "The ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "Hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "Is the mapping user defined", + "name": "isuserdefined", "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": "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": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "The ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the hypervisor", + "description": "The hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "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" + } ], "since": "4.4.0" }, { - "description": "List all public, private, and privileged templates.", + "description": "List all public, private, and privileged Templates.", "isasync": false, "name": "listTemplates", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list templates that are ready to be deployed", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "isready", + "name": "isvnf", "required": false, - "since": "4.21.0", + "since": "4.19.0", "type": "boolean" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the OS category for the template", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "list datadisk templates by parent template id", + "description": "The hypervisor for which to restrict the search", "length": 255, - "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "hypervisor", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "list templates that can be used to deploy CKS clusters", + "description": "If set to true, list only unique Templates across zones", "length": 255, - "name": "forcks", + "name": "showunique", "required": false, - "since": "4.21.0", + "since": "4.13.2", "type": "boolean" }, { - "description": "the template ID", + "description": "The Template ID", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -95609,22 +95709,16 @@ "type": "uuid" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "show removed templates as well", + "description": "List datadisk Templates by parent Template id", "length": 255, - "name": "showremoved", + "name": "parenttemplateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "list templates by zoneId", + "description": "List Templates by zoneId", "length": 255, "name": "zoneid", "related": "listZones", @@ -95632,548 +95726,557 @@ "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "hypervisor", + "name": "forcks", "required": false, + "since": "4.21.0", + "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 Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).", + "length": 255, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "ID of the extension for the template", + "description": "ID of the storage pool", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.21.0", + "since": "4.19", "type": "uuid" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "ID of the image or image cache store", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "since": "4.9", - "type": "list" + "since": "4.19", + "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": "the type of the template", + "description": "Comma separated list of Template details requested, value can be a list of [all, min]", "length": 255, - "name": "templatetype", + "name": "details", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.15", + "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": "Show removed Templates as well", "length": 255, - "name": "listall", + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "", + "description": "list templates that are ready to be deployed", "length": 255, - "name": "pagesize", + "name": "isready", "required": false, - "type": "integer" + "since": "4.21.0", + "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": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "ID of the storage pool", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "", "length": 255, - "name": "arch", + "name": "page", "required": false, - "since": "4.20", - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The IDs of the Templates, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "", + "description": "The Template name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "ID of the extension for the template", "length": 255, - "name": "showicon", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the ID of the OS category for the template", + "description": "the type of the template", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "templatetype", "required": false, - "since": "4.21.0", - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "ID of the image or image cache store", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "arch", "required": false, - "since": "4.19", - "type": "uuid" + "since": "4.20", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to true, list only unique templates across zones", + "description": "List by keyword", "length": 255, - "name": "showunique", + "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, - "since": "4.13.2", "type": "boolean" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "Flag to display the resource image for the Templates", "length": 255, - "name": "details", + "name": "showicon", "required": false, - "since": "4.15", - "type": "list" + "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" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", + "type": "string" }, { - "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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "The id of userdata linked to this Template", + "name": "userdataid", + "type": "string" + }, + { + "description": "The Account id to which the Template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { - "description": "the project name of the template", + "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", + "description": "The processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the OS type for this template.", + "description": "The name of the OS type for this Template.", "name": "ostypename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Checksum of the Template", + "name": "checksum", + "type": "string" + }, + { + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, + { + "description": "Lists the download progress of a Template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "The type of the Template", + "name": "templatetype", + "type": "string" + }, + { + "description": "Path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "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 date this Template was created", + "name": "created", + "type": "date" }, { - "description": "the tag of this template", + "description": "The tag of this Template", "name": "templatetag", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "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 date this template was created", - "name": "created", - "type": "date" + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The URL which the Template/ISO is registered from", + "name": "url", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "The Template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the template ID", - "name": "id", + "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", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "The date this Template was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "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 ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "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", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the template display text", - "name": "displaytext", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, + {}, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" } ] }, { - "description": "create Tungsten-Fabric policy", + "description": "Create Tungsten-Fabric policy", "isasync": true, "name": "createTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric policy name", + "description": "The ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -96184,13 +96287,13 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" + "description": "List Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { @@ -96198,6 +96301,11 @@ "name": "zonename", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {}, {} ] @@ -96219,25 +96327,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 current status of the latest async job acting 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", + "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.20.0" @@ -96248,19 +96356,12 @@ "name": "createBucket", "params": [ { - "description": "Id of the Object Storage Pool where bucket is created", - "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool", - "required": true, - "type": "uuid" - }, - { - "description": "The Bucket access policy", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "policy", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Bucket Quota in GiB", @@ -96278,17 +96379,9 @@ "type": "uuid" }, { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "Enable bucket versioning", + "description": "Enable object locking in bucket", "length": 255, - "name": "versioning", + "name": "objectlocking", "required": false, "type": "boolean" }, @@ -96300,11 +96393,11 @@ "type": "boolean" }, { - "description": "Enable object locking in bucket", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", "length": 255, - "name": "objectlocking", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the name of the bucket", @@ -96314,126 +96407,69 @@ "type": "string" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "description": "Enable bucket versioning", "length": 255, - "name": "account", + "name": "versioning", "required": false, - "type": "string" - } - ], - "related": "listBuckets", - "response": [ - { - "description": "Bucket Object Locking", - "name": "objectlocking", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "Id of the Object Storage Pool where bucket is created", + "length": 255, + "name": "objectstorageid", + "related": "addObjectStoragePool", + "required": true, + "type": "uuid" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "The Bucket access policy", + "length": 255, + "name": "policy", + "required": false, "type": "string" - }, + } + ], + "related": "listBuckets", + "response": [ + {}, { - "description": "Bucket Versioning", - "name": "versioning", + "description": "Bucket Object Locking", + "name": "objectlocking", "type": "boolean" }, - {}, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" }, { - "description": "State of the Bucket", - "name": "state", + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { @@ -96442,60 +96478,132 @@ "type": "string" }, { - "description": "Bucket Quota in GiB", - "name": "quota", + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" }, { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" }, { "description": "Bucket Secret Key", @@ -96503,13 +96611,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" } ], @@ -96521,25 +96629,33 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "search by name", + "description": "Search by name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "The Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { "description": "", @@ -96549,90 +96665,82 @@ "type": "integer" }, { - "description": "list physical network by id", + "description": "List physical network by id", "length": 255, "name": "id", "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" - }, - { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" } ], "related": "updatePhysicalNetwork", "response": [ { - "description": "name of the physical network", - "name": "name", + "description": "The domain ID of the physical Network owner", + "name": "domainid", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "The UUID of the physical Network", + "name": "id", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "The speed of the physical Network", + "name": "networkspeed", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "Zone ID of the physical Network", + "name": "zoneid", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "Comma separated tag", + "name": "tags", "type": "string" }, + {}, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "State of the physical Network", + "name": "state", "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" }, { - "description": "comma separated tag", - "name": "tags", + "description": "Broadcast domain range of the physical Network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "Name of the physical Network", + "name": "name", "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" } ], "since": "3.0.0" @@ -96643,51 +96751,43 @@ "name": "listFirewallRules", "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": "list firewall rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "pagesize", "required": false, - "since": "4.3", - "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 only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "createProject", @@ -96695,198 +96795,206 @@ "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 only resources belonging to the domain specified", + "description": "The ID of IP address of the firewall services", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "List firewall rules for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.3", "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 IP address of the firewall services", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ - {}, - { - "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", - "type": "string" - }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "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 ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The 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": "the project id the tag belongs to", - "name": "projectid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the 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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The 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": "Error code for this ICMP message", + "name": "icmpcode", "type": "integer" }, + { + "description": "The traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, {}, { - "description": "type of the icmp message being sent", + "description": "The ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "Type of the ICMP message being sent", "name": "icmptype", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "The public IP address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of firewall rule's port range", + "description": "The starting port of firewall rule's port range", "name": "startport", "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "The ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "The public IP address ID for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the network id of the firewall rule", + "description": "The Network ID of the firewall rule", "name": "networkid", "type": "string" - } + }, + { + "description": "The protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + {} ] }, { @@ -96905,149 +97013,27 @@ ], "response": [ {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", - "params": [ - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, - { - "description": "the ID of the zone where the ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - } - ], - "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", - "response": [ - { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", - "type": "string" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - { - "description": "type of the storage", - "name": "storagetype", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "", - "name": "resultstring", - "type": "string" - }, - { - "description": "the state of the extracted object", - "name": "state", - "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 extracted object belongs", - "name": "accountid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the id of extracted object", - "name": "id", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - {}, - {}, - { - "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" - } + {} ] }, { @@ -97056,25 +97042,26 @@ "name": "listRoutingFirewallRules", "params": [ { - "description": "list Routing firewall rules by traffic type - ingress or egress", + "description": "", "length": 255, - "name": "traffictype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list Routing firewall rules by network ID", @@ -97084,20 +97071,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, @@ -97106,21 +97079,22 @@ "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "tags", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "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": "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", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "createProject", @@ -97128,187 +97102,321 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list Routing firewall rules by traffic type - ingress or egress", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" + }, + { + "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, + "name": "fordisplay", + "required": false, + "type": "boolean" } ], "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "The Instance 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 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", + "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 public IP address for the port forwarding rule", + "name": "ipaddress", + "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 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The Instance 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 ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", + "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 Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "The ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "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 Instance ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ + { + "description": "The ID of the ISO file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "The URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "The ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + } + ], + "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", + "response": [ + { + "description": "Zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, {}, + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "The time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "Type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The ID of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "Zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "The name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "The Account ID to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "The status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "The state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "The upload ID of extracted object", + "name": "extractId", "type": "string" } - ], - "since": "4.20.0" + ] }, { "description": "Creates an affinity/anti-affinity group", @@ -97316,39 +97424,32 @@ "name": "createAffinityGroup", "params": [ { - "description": "optional description of the affinity group", + "description": "Optional description of the affinity group", "length": 255, "name": "description", "required": false, "type": "string" }, { - "description": "create affinity group for project", + "description": "DomainId of the account owning the affinity group", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "name of the affinity group", + "description": "Name of the affinity group", "length": 255, "name": "name", "required": true, "type": "string" }, { - "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,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, @@ -97358,81 +97459,88 @@ "name": "type", "required": true, "type": "string" + }, + { + "description": "An account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the domain ID of the affinity group", + "description": "The domain ID of the affinity group", "name": "domainid", "type": "string" }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, { "description": "dedicated resources associated with this affinity group", "name": "dedicatedresources", "type": "list" }, { - "description": "the description of the affinity group", + "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", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", + "description": "Instance IDs associated with this affinity group", "name": "virtualmachineIds", "type": "list" }, - {}, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The project ID of the affinity group", + "name": "projectid", "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 ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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" } ] }, @@ -97463,118 +97571,118 @@ "type": "string" }, { - "description": "Email id with which user tried to login using OAuth provider", + "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": "email", - "required": true, + "name": "domain", + "required": false, "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Email id with which user tried to login using OAuth provider", "length": 255, - "name": "domain", - "required": false, + "name": "email", + "required": true, "type": "string" } ], - "related": "samlSso", + "related": "", "response": [ + { + "description": "The time period before the session has expired", + "name": "timeout", + "type": "integer" + }, { "description": "Is two factor authentication enabled", "name": "is2faenabled", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Username", + "name": "username", "type": "string" }, - {}, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "The Account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "User time zone", + "name": "timezone", + "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "First name of the user", + "name": "firstname", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, + {}, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "last name of the user", + "description": "Last name of the user", "name": "lastname", "type": "string" }, { - "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": "User ID", - "name": "userid", + "description": "The Account name the User belongs to", + "name": "account", "type": "string" }, { - "description": "Username", - "name": "username", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "User time zoneoffset", + "name": "timezoneoffset", "type": "string" }, - {}, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.19.0" @@ -97585,12 +97693,11 @@ "name": "listInternalLoadBalancerElements", "params": [ { - "description": "list internal load balancer elements by network service provider id", + "description": "List internal load balancer elements by enabled state", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listTrafficTypes", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List by keyword", @@ -97600,7 +97707,7 @@ "type": "string" }, { - "description": "list internal load balancer elements by id", + "description": "List internal load balancer elements by ID", "length": 255, "name": "id", "related": "listInternalLoadBalancerElements", @@ -97608,55 +97715,56 @@ "type": "uuid" }, { - "description": "list internal load balancer elements by enabled state", + "description": "List internal load balancer elements by network service provider ID", "length": 255, - "name": "enabled", + "name": "nspid", + "related": "addNetworkServiceProvider,listTrafficTypes", "required": false, - "type": "boolean" + "type": "uuid" }, { "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 id of the internal load balancer element", + "description": "The ID of the internal Load balancer element", "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the 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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" @@ -97667,71 +97775,71 @@ "name": "getHypervisorGuestOsNames", "params": [ { - "description": "Hypervisor type. One of : VMware, XenServer", + "description": "Hypervisor version to get the guest OS names (at least one hypervisor host with the version specified must be available)", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": true, "type": "string" }, { - "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", + "description": "Keyword for guest OS name", "length": 255, - "name": "hypervisorversion", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Keyword for guest os name", + "description": "Hypervisor type. One of : VMware, XenServer", "length": 255, - "name": "keyword", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", - "type": "string" + "description": "The guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Version of the hypervisor for guest os names", + "name": "hypervisorversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest OS list of the hypervisor", + "description": "The guest OS list of the hypervisor", "name": "guestoslist", "response": [ { - "description": "hypervisor specific name for the Guest OS", + "description": "Hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" }, { - "description": "standard display name for the Guest OS", + "description": "Standard display name for the Guest OS", "name": "osdisplayname", "type": "string" } ], "type": "list" }, - {}, - {}, { - "description": "the hypervisor", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The hypervisor", "name": "hypervisor", "type": "string" }, + {}, { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ], @@ -97742,20 +97850,6 @@ "isasync": false, "name": "createTungstenFabricProvider", "params": [ - { - "description": "Tungsten-Fabric provider vrouter port", - "length": 255, - "name": "tungstenprovidervrouterport", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric provider hostname", - "length": 255, - "name": "tungstenproviderhostname", - "required": true, - "type": "string" - }, { "description": "Tungsten-Fabric provider introspect port", "length": 255, @@ -97764,13 +97858,20 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", "required": true, "type": "uuid" }, + { + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "name": "tungstenproviderhostname", + "required": true, + "type": "string" + }, { "description": "Tungsten-Fabric provider gateway", "length": 255, @@ -97791,29 +97892,36 @@ "name": "tungstenproviderport", "required": false, "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "length": 255, + "name": "tungstenprovidervrouterport", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { @@ -97821,20 +97929,25 @@ "name": "tungstenprovidervrouterport", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, { @@ -97843,37 +97956,64 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "true if security groups support is enabled, false otherwise", + "description": "True if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" - }, - { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", - "type": "string" } ] }, { - "description": "Reboots a virtual machine.", + "description": "Enables HA cluster-wide", "isasync": true, - "name": "rebootVirtualMachine", + "name": "enableHAForCluster", "params": [ { - "description": "The ID of the virtual machine", + "description": "ID of the cluster", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "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": "The 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": "Reboots an Instance.", + "isasync": true, + "name": "rebootVirtualMachine", + "params": [ { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "Force reboot the Instance (It is Stopped and then Started)", "length": 255, "name": "forced", "required": false, @@ -97887,221 +98027,138 @@ "required": false, "since": "4.15.0.0", "type": "boolean" + }, + { + "description": "The ID of the Instance", + "length": 255, + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ + {}, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "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": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "The ID of the Instance", + "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", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "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", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { @@ -98110,984 +98167,1040 @@ "type": "date" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "The internal memory (KiB) that's free in Instance 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": "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "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 total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "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", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The Account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 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": "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" + } + ], + "type": "set" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The 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" + } + ], + "type": "set" + }, + { + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The project name of the group", + "name": "project", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The ID of the security group", + "name": "id", "type": "string" }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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 CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", + "description": "The Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", + "description": "The IPv6 address of Network", "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the corresponding network", + "description": "The ID of the corresponding Network", "name": "networkid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "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 nic", - "name": "id", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "The account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "Instance 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": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "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 format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The state of the Instance", + "name": "state", "type": "string" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the VM's disk write in KiB", + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The Instance's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "An alternate display text of the Template for the Instance", + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The User's ID who deployed the Instance", "name": "userid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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 Instance", + "name": "isoname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account owning the security group", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Enables HA cluster-wide", - "isasync": true, - "name": "enableHAForCluster", - "params": [ + }, { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The password (if exists) of the Instance", + "name": "password", + "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 Instance exists", + "name": "domainid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, - {} - ], - "since": "4.11" + { + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + } + ] }, { "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", @@ -99095,18 +99208,10 @@ "name": "addVirtualMachinesToKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "description": "the IDs of the VMs to add to the cluster", + "description": "The IDs of the VMs to add to the cluster", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "list" }, @@ -99116,27 +99221,35 @@ "name": "iscontrolnode", "required": false, "type": "boolean" + }, + { + "description": "The ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, @@ -99145,12 +99258,12 @@ "since": "4.19.0" }, { - "description": "list Tungsten-Fabric logical router", + "description": "List Tungsten-Fabric logical router", "isasync": false, "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -99158,32 +99271,32 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "The uuid of Tungsten-Fabric network", "length": 255, - "name": "keyword", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "", + "description": "The uuid of Tungsten-Fabric logical router", "length": 255, - "name": "pagesize", + "name": "logicalrouteruuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "List by keyword", "length": 255, - "name": "logicalrouteruuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "", "length": 255, - "name": "networkuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -99195,6 +99308,7 @@ ], "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + {}, { "description": "Tungsten-Fabric logical router name", "name": "name", @@ -99202,15 +99316,25 @@ }, {}, { - "description": "list Tungsten-Fabric policy network name", + "description": "List Tungsten-Fabric policy network name", "name": "network", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -99220,17 +99344,6 @@ "description": "Tungsten-Fabric logical router uuid", "name": "uuid", "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -99248,99 +99361,99 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "The backup offering ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", "required": false, - "type": "string" + "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": "The backup offering ID", + "description": "", "length": 255, - "name": "id", - "related": "listBackupOfferings,updateBackupOffering", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "updateBackupOffering", "response": [ + {}, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", "type": "boolean" }, { - "description": "provider name", - "name": "provider", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone name", - "name": "zonename", - "type": "string" + "description": "The date this backup offering was created", + "name": "created", + "type": "date" }, { - "description": "the backups with this offering can be used to create Instances on all Zones", - "name": "crosszoneinstancecreation", + "description": "Whether the offering allows User driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone name", + "name": "zonename", "type": "string" }, { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" + "description": "ID of the backup offering", + "name": "id", + "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", + "description": "Name for the backup offering", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "ID of the backup offering", - "name": "id", + "description": "External ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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": "Description for the backup offering", + "name": "description", "type": "string" - } + }, + {} ], "since": "4.14.0" }, @@ -99350,112 +99463,112 @@ "name": "listGpuCards", "params": [ { - "description": "vendor name of the GPU card", + "description": "device name of the GPU card", "length": 255, - "name": "vendorname", + "name": "devicename", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "device ID of the GPU card", "length": 255, - "name": "keyword", + "name": "deviceid", "required": false, "type": "string" }, { - "description": "", + "description": "vendor ID of the GPU card", "length": 255, - "name": "page", + "name": "vendorid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "device ID of the GPU card", + "description": "ID of the GPU card", "length": 255, - "name": "deviceid", + "name": "id", + "related": "listGpuCards", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "vendor ID of the GPU card", + "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", "length": 255, - "name": "vendorid", + "name": "activeonly", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "device name of the GPU card", + "description": "vendor name of the GPU card", "length": 255, - "name": "devicename", + "name": "vendorname", "required": false, "type": "string" }, { - "description": "ID of the GPU card", + "description": "", "length": 255, - "name": "id", - "related": "listGpuCards", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", + "description": "List by keyword", "length": 255, - "name": "activeonly", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ {}, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, + {}, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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 device name of the GPU card", + "name": "devicename", "type": "string" }, - {}, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "the device ID of the GPU card", - "name": "deviceid", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" } ], @@ -99467,12 +99580,18 @@ "name": "addGuestOsMapping", "params": [ { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "hypervisorversion", + "required": true, + "type": "string" + }, + { + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "length": 255, + "name": "osdisplayname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", @@ -99490,16 +99609,17 @@ "type": "string" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, - "name": "osdisplayname", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", "length": 255, - "name": "hypervisorversion", + "name": "hypervisor", "required": true, "type": "string" }, @@ -99510,62 +99630,55 @@ "required": false, "since": "4.19.0", "type": "boolean" - }, - { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" } ], "related": "updateGuestOsMapping", "response": [ { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "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": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "Is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "The hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "Version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "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": "is the mapping user defined", - "name": "isuserdefined", + "description": "The ID of the Guest OS mapping", + "name": "id", "type": "string" } ], @@ -99577,69 +99690,66 @@ "name": "listVnfTemplates", "params": [ { - "description": "list datadisk templates by parent template id", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "account", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "arch", + "name": "isvnf", "required": false, - "since": "4.20", - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "ID of the extension for the template", + "description": "Flag to display the resource image for the Templates", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "name": "showicon", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "The IDs of the Templates, mutually exclusive with id", "length": 255, - "name": "page", + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "integer" + "since": "4.9", + "type": "list" }, { - "description": "list templates by zoneId", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "forcks", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "Show removed Templates as well", "length": 255, - "name": "isvnf", + "name": "showremoved", "required": false, - "since": "4.19.0", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to true, list only unique Templates across zones", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "showunique", "required": false, - "type": "uuid" + "since": "4.13.2", + "type": "boolean" }, { - "description": "list templates that are ready to be deployed", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "isready", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the OS category for the template", @@ -99651,77 +99761,80 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the type of the template", "length": 255, - "name": "tags", + "name": "templatetype", "required": false, - "type": "map" + "since": "4.19.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IDs of the templates, mutually exclusive with 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": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "listall", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The Template ID", "length": 255, - "name": "listall", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the type of the template", + "description": "The Template name", "length": 255, - "name": "templatetype", + "name": "name", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "List datadisk Templates by parent Template id", "length": 255, - "name": "hypervisor", + "name": "parenttemplateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "list templates that can be used to deploy CKS clusters", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "forcks", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "keyword", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "ID of the extension for the template", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "show removed templates as well", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showremoved", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -99733,414 +99846,414 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "the template ID", + "description": "The hypervisor for which to restrict the search", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to true, list only unique templates across zones", + "description": "list templates that are ready to be deployed", "length": 255, - "name": "showunique", + "name": "isready", "required": false, - "since": "4.13.2", + "since": "4.21.0", "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": "the template name", + "description": "Possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).", "length": 255, - "name": "name", - "required": false, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "List Templates by zoneId", "length": 255, - "name": "showicon", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "Comma separated list of Template details requested, value can be a list of [all, min]", "length": 255, "name": "details", "required": false, "since": "4.15", "type": "list" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ + { + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The status of the Template", + "name": "status", "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": "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": "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 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" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "The project name of the Template", + "name": "project", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "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", + "name": "zoneid", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The tag of this Template", + "name": "templatetag", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" }, { - "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 project id of the template", - "name": "projectid", + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "The name of the domain to which the Template belongs", + "name": "domain", + "type": "string" }, + {}, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Template display text", + "name": "displaytext", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The size of the Template", + "name": "size", + "type": "long" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, { - "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 name of userdata linked to this template", - "name": "userdataname", + "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 this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the format of the template.", + "description": "The format of the Template.", "name": "format", "type": "imageformat" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "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 date this Template was removed", + "name": "removed", + "type": "date" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "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 display text", - "name": "displaytext", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "The processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "The id of userdata linked to this Template", + "name": "userdataid", + "type": "string" + }, + {}, + { + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The type of the Template", + "name": "templatetype", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", + "description": "True if the Template is managed across all Zones, false otherwise", "name": "crossZones", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" } ], "since": "4.19.0" @@ -100151,258 +100264,235 @@ "name": "deployVnfAppliance", "params": [ { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "ip6address", "required": false, - "type": "list" + "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": "the mac address for default vm's network", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "macaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "bootmode", + "name": "userdatadetails", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.18", + "type": "map" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "keypair", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "leaseexpiryaction", + "name": "customid", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "False by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. True otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", "length": 255, - "name": "iothreadsenabled", + "name": "vnfconfiguremanagement", "required": false, "type": "boolean" }, { - "description": "", + "description": "the ip address for default vm's network", "length": 255, - "name": "snapshotid", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "ipaddress", "required": false, - "since": "4.21", - "type": "uuid" + "type": "string" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "rootdisksize", + "name": "displayvm", "required": false, - "since": "4.4", - "type": "long" + "since": "4.2", + "type": "boolean" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "keypairs", + "name": "displayname", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "vnfcidrlist", "required": false, - "type": "map" + "type": "list" }, { - "description": "the ipv6 address for default vm's network", + "description": "The ID of the Template for the Instance", "length": 255, - "name": "ip6address", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "datadiskofferinglist", + "name": "rootdisksize", "required": false, - "since": "4.11", - "type": "map" + "since": "4.4", + "type": "long" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "startvm", + "name": "deploymentplanner", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the ID of the Userdata", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18", "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "Deploy vm for the project", "length": 255, - "name": "size", + "name": "projectid", + "related": "createProject", "required": false, - "type": "long" + "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", - "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", - "required": false, - "type": "list" - }, - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "The number of queues for multiqueue NICs.", - "length": 255, - "name": "nicmultiqueuenumber", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "since": "4.18", - "type": "integer" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "iptonetworklist", "required": false, - "since": "4.18", "type": "map" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", - "required": false, - "since": "4.18", - "type": "uuid" - }, - { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", - "length": 255, - "name": "keyboard", - "required": false, - "type": "string" - }, - { - "description": "an optional account for the virtual machine. 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": "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": "Enable packed virtqueues or not.", "length": 255, - "name": "hypervisor", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "", "length": 255, - "name": "customid", + "name": "snapshotid", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "string" + "since": "4.21", + "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "displayvm", + "name": "dynamicscalingenabled", "required": false, - "since": "4.2", + "since": "4.16", "type": "boolean" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "length": 255, + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", + "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": "datadisksdetails", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.21.0", - "type": "map" + "type": "list" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "externaldetails", + "name": "keypairs", "required": false, - "since": "4.21.0", - "type": "map" + "since": "4.17", + "type": "list" }, { - "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": "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": "boottype", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "list" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "details", + "name": "iothreadsenabled", "required": false, - "since": "4.3", - "type": "map" + "type": "boolean" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, + "since": "4.21", "type": "uuid" }, { - "description": "used to specify the vApp properties.", + "description": "Number of days instance is leased for.", "length": 255, - "name": "properties", + "name": "leaseduration", "required": false, - "since": "4.15", - "type": "map" + "since": "4.21.0", + "type": "integer" }, { - "description": "Enable packed virtqueues or not.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "copyimagetags", "required": false, - "since": "4.18", + "since": "4.13", "type": "boolean" }, { @@ -100414,54 +100504,43 @@ "type": "string" }, { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, - { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "iptonetworklist", + "name": "externaldetails", "required": false, + "since": "4.21.0", "type": "map" }, { - "description": "the mac address for default vm's network", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "macaddress", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "datadisksdetails", "required": false, - "type": "list" + "since": "4.21.0", + "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", "length": 255, - "name": "group", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "host name for the virtual machine", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", "length": 255, - "name": "name", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "type": "string" }, { @@ -100474,720 +100553,462 @@ "type": "uuid" }, { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "description": "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": "vnfconfiguremanagement", + "name": "datadiskofferinglist", "required": false, - "type": "boolean" + "since": "4.11", + "type": "map" }, { - "description": "Number of days instance is leased for.", + "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": "leaseduration", + "name": "nicnetworklist", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.15", + "type": "map" }, { - "description": "Controls specific policies on IO", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "iodriverpolicy", + "name": "startvm", "required": false, - "type": "string" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "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": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "details", "required": false, - "type": "list" + "since": "4.3", + "type": "map" }, { - "description": "the ip address for default vm's network", + "description": "Controls specific policies on IO", "length": 255, - "name": "ipaddress", + "name": "iodriverpolicy", "required": false, "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "host name for the virtual machine", "length": 255, - "name": "copyimagetags", + "name": "name", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "Deploy vm for the project", + "description": "The ID of the Service offering for the Instance", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "deploymentplanner", + "name": "nicmultiqueuenumber", "required": false, - "since": "4.4", - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "password", + "name": "keyboard", "required": false, - "since": "4.19.0.0", "type": "string" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "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": "securitygroupids", + "name": "securitygroupnames", "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "description": "", + "description": "an optional group for the virtual machine", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "group", "required": false, - "since": "4.21", - "type": "uuid" + "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": "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": "nicnetworklist", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.15", "type": "map" }, { - "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "vnfcidrlist", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "list" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "response": [ - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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 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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "VNF details", - "name": "vnfdetails", + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", "type": "map" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", "type": "boolean" - }, + } + ], + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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 account owning the security group", - "name": "account", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", + "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": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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 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 starting IP of the security group rule", - "name": "startport", + "description": "The type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "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", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", + "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": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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": "Account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the 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", + "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", + "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 protocol of the security group rule", - "name": "protocol", + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", + "description": "The code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", + "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 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 ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } @@ -101195,284 +101016,399 @@ "type": "set" }, { - "description": "the id of the security group rule", + "description": "The ID of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "Security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The Account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "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 Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "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": "id of the resource", - "name": "resourceid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "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": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "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 traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, - {}, { - "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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 vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the count of GPUs on the virtual machine", @@ -101480,81 +101416,86 @@ "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The name of the affinity group", + "name": "name", "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "The description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "Instance 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 domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "The project name of the affinity group", "name": "project", "type": "string" } @@ -101562,200 +101503,377 @@ "type": "set" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "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": "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 Instance 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 memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The 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": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "the ID of the gpu card to which service offering is linked", "name": "gpucardid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The project name of the Instance", + "name": "project", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" } ], "since": "4.19.0" @@ -101766,81 +101884,81 @@ "name": "updateNetworkOffering", "params": [ { - "description": "sort key of the network offering, integer", + "description": "The name of the network offering", "length": 255, - "name": "sortkey", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "Sort key of the network offering, integer", "length": 255, - "name": "keepaliveenabled", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the name of the network offering", + "description": "The availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", "length": 255, - "name": "name", + "name": "availability", "required": false, "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", + "description": "The tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the id of the network offering", + "description": "The display text of the network offering", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", + "description": "Update state for the network offering", "length": 255, - "name": "availability", + "name": "state", "required": false, "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", "required": false, - "since": "4.13", - "type": "string" + "type": "boolean" }, { - "description": "the display text of the network offering", + "description": "Maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "displaytext", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "The ID of the network offering", "length": 255, - "name": "domainid", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "update state for the network offering", - "length": 255, - "name": "state", + "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": "the tags for the network offering.", + "description": "The ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, - "name": "tags", + "name": "domainid", "required": false, "type": "string" } @@ -101848,90 +101966,101 @@ "related": "createNetworkOffering,listNetworkOfferings", "response": [ { - "description": "true if network offering supports specifying ip ranges, false otherwise", + "description": "True if Network offering supports specifying IP ranges, false otherwise", "name": "specifyipranges", "type": "boolean" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "The ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "availability of the network offering", - "name": "availability", - "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "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 internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "True if Network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "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 list of supported services", + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" }, { - "description": "the service provider name", + "description": "The service provider name", "name": "provider", "response": [ { - "description": "uuid of the network provider", + "description": "UUID of the Network provider", "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "The provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", + "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": "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 physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" } @@ -101939,23 +102068,23 @@ "type": "list" }, { - "description": "the list of capabilities", + "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", + "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" @@ -101964,81 +102093,75 @@ "type": "list" }, { - "description": "the id of the network offering", - "name": "id", + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, + {}, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "description": "Availability of the Network offering", + "name": "availability", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "True if Network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "The date this Network offering was created", + "name": "created", + "type": "date" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "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 guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "True if Network offering can be used by VPC Networks only", + "name": "forvpc", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "description": "Data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "True if Network offering supports VLANs, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" + "description": "True if Network offering can be used by Tungsten-Fabric Networks only", + "name": "fortungsten", + "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": "Maximum number of concurrent connections to be handled by LB", + "name": "maxconnections", + "type": "integer" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { "description": "the routing mode for the network offering, supported types are Static or Dynamic.", @@ -102046,62 +102169,57 @@ "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "The name of the Network offering", + "name": "name", "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "An alternate display text of the Network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "Guest type of the Network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "Additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "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(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": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "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 network offering", - "name": "name", + "description": "The tags for the Network offering", + "name": "tags", "type": "string" }, { - "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.", + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" } @@ -102113,7 +102231,7 @@ "name": "changeOutOfBandManagementPassword", "params": [ { - "description": "the ID of the host", + "description": "The ID of the host", "length": 255, "name": "hostid", "related": "declareHostAsDegraded,reconnectHost", @@ -102121,7 +102239,7 @@ "type": "uuid" }, { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "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, @@ -102131,70 +102249,70 @@ "related": "enableOutOfBandManagementForHost", "response": [ { - "description": "the out-of-band management interface powerState of the host", + "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 out-of-band management driver for the host", + "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", + "description": "The operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "True if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The out-of-band management action (if issued)", + "name": "action", "type": "string" }, - {}, { - "description": "the out-of-band management interface username", + "description": "The out-of-band management interface username", "name": "username", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "The out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "The out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The operation result description", + "name": "description", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -102213,90 +102331,90 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by resource type", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "list by key", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "key", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by key, value. Needs to be passed only along with key", "length": 255, - "name": "account", + "name": "value", "required": false, + "since": "4.4", "type": "string" }, { - "description": "list by resource id", + "description": "List by resource ID", "length": 255, "name": "resourceid", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.3", + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "description": "List by key", "length": 255, - "name": "fordisplay", + "name": "key", "required": false, - "since": "4.3", - "type": "boolean" + "type": "string" }, { - "description": "list by resource type", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "value", + "name": "isrecursive", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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" } @@ -102304,70 +102422,70 @@ "related": "", "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", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, - {}, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "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" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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", + "type": "string" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -102379,290 +102497,295 @@ "name": "createNetworkOffering", "params": [ { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "description": "True if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, "name": "fortungsten", "required": false, "type": "boolean" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "The ID of the containing zone(s), null for public offerings", "length": 255, - "name": "serviceproviderlist", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "map" + "since": "4.13", + "type": "list" }, { - "description": "desired service capabilities as part of network offering", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "servicecapabilitylist", + "name": "fornsx", "required": false, - "type": "map" + "since": "4.20.0", + "type": "boolean" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "description": "True if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "availability", + "name": "ispersistent", + "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 tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "true if network offering for NSX network offering supports Load balancer service.", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "nsxsupportlb", + "name": "routingmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "Desired service capabilities as part of network offering", "length": 255, - "name": "networkrate", + "name": "servicecapabilitylist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "true if network offering supports choosing AS number", + "description": "The service offering ID used by virtual router provider", "length": 255, - "name": "specifyasnumber", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "details", "required": false, - "type": "list" + "since": "4.2.0", + "type": "map" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "The ID of the containing domain(s), null for public offerings", "length": 255, - "name": "networkmode", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.20.0", - "type": "string" + "type": "list" }, { - "description": "Name of the provider providing the service", + "description": "True if network offering supports VLANs", "length": 255, - "name": "provider", + "name": "specifyvlan", "required": false, - "since": "4.21.0", - "type": "string" + "type": "boolean" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "True if the network offering is IP conserve mode enabled", "length": 255, - "name": "fornsx", + "name": "conservemode", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "services supported by the network offering", + "description": "Guest type of the network offering: Shared or Isolated", "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "name": "guestiptype", + "required": true, + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "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": "specifyipranges", + "name": "serviceproviderlist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "description": "Name of the provider providing the service", "length": 255, - "name": "internetprotocol", + "name": "provider", "required": false, - "since": "4.17.0", + "since": "4.21.0", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "True if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, "name": "egressdefaultpolicy", "required": false, "type": "boolean" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "Set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "ispersistent", + "name": "enable", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "Data transfer rate in megabits per second allowed", "length": 255, - "name": "maxconnections", + "name": "networkrate", "required": false, "type": "integer" }, { - "description": "the display text of the network offering, defaults to the value of 'name'.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "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 traffic type for the network offering. Supported type in current release is GUEST only", + "description": "Services supported by the network offering", "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "name": "supportedservices", + "required": false, + "type": "list" }, { - "description": "the service offering ID used by virtual router provider", + "description": "True if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "nsxsupportlb", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "boolean" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "true if network offering supports choosing AS number", "length": 255, - "name": "forvpc", + "name": "specifyasnumber", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "the name of the network offering", + "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": "name", - "required": true, - "type": "string" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "name": "internetprotocol", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "true if network offering supports vlans", + "description": "True if network offering for NSX network offering supports Internal Load balancer service.", "length": 255, - "name": "specifyvlan", + "name": "nsxsupportsinternallb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "description": "True if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "nsxsupportsinternallb", + "name": "forvpc", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "routingmode", + "name": "networkmode", "required": false, "since": "4.20.0", "type": "string" }, { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" - }, - { - "description": "guest type of the network offering: Shared or Isolated", + "description": "The traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, - "name": "guestiptype", + "name": "traffictype", "required": true, "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "True if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "specifyipranges", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "The display text of the network offering, defaults to the value of 'name'.", "length": 255, - "name": "enable", + "name": "displaytext", "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": "The name of the network offering", "length": 255, - "name": "details", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "length": 255, + "name": "availability", "required": false, - "since": "4.2.0", - "type": "map" + "type": "string" } ], "related": "listNetworkOfferings", "response": [ { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "True if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "Guest type of the Network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "The traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "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 for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "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": "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": "true if network offering supports network that span multiple zones", + "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": "The internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { "description": "true if network offering supports public access for guest networks", @@ -102670,79 +102793,114 @@ "type": "boolean" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", + "description": "True if Network offering can be used by VPC Networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "The ID of the Network offering", + "name": "id", + "type": "string" + }, + { + "description": "An alternate display text of the Network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "True if Network offering supports specifying IP ranges, false otherwise", "name": "specifyipranges", "type": "boolean" }, { - "description": "the list of supported services", + "description": "Data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "Availability of the Network offering", + "name": "availability", + "type": "string" + }, + { + "description": "True if Network offering supports VLANs, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "The list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "The capability name", + "name": "name", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The capability value", + "name": "value", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "The service provider name", + "name": "provider", + "response": [ + { + "description": "UUID of the Network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the provider name", + "description": "The provider name", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" }, { - "description": "the capability name", - "name": "name", + "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": "Services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -102751,131 +102909,91 @@ "type": "list" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "The ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "The tags for the Network offering", + "name": "tags", + "type": "string" + }, + { + "description": "True if Network offering can be used by Tungsten-Fabric Networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", + "description": "True if Network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "True if Network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "availability of the network offering", - "name": "availability", - "type": "string" + "description": "Additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Maximum number of concurrent connections to be handled by LB", + "name": "maxconnections", + "type": "integer" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "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 routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "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 network offering", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "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 service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "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", - "type": "integer" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "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", - "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": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "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 choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" } ], "since": "3.0.0" @@ -102886,25 +103004,25 @@ "name": "dedicateCluster", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "The name of the account which needs dedication. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the Cluster", + "description": "The ID of the containing domain", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "The ID of the Cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } @@ -102913,44 +103031,44 @@ "response": [ {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "The ID of the cluster", + "name": "clusterid", "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", + "description": "The domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "The name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "The Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "The Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "The ID of the dedicated resource", + "name": "id", "type": "string" } ] @@ -102961,205 +103079,205 @@ "name": "createIpForwardingRule", "params": [ { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "description": "The public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the start port for the rule", + "description": "The start port for the rule", "length": 255, "name": "startport", "required": true, "type": "integer" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "The end port for the rule", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the end port for the rule", + "description": "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "The protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "protocol", "required": true, - "type": "uuid" + "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 explicitly. Has value true by default", "length": 255, - "name": "cidrlist", + "name": "openfirewall", "required": false, - "type": "list" + "type": "boolean" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ - {}, - { - "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", - "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", + "description": "The Instance IP address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "The state of the rule", + "name": "state", "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "The ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "The public IP address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "The Instance name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "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": "the state of the rule", - "name": "state", + "description": "The protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with the rule", + "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": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } ], "type": "list" - } + }, + { + "description": "The ID of the guest Network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The 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" + }, + {} ] }, { @@ -103168,7 +103286,7 @@ "name": "listElastistorInterface", "params": [ { - "description": "controller id", + "description": "Controller ID", "length": 255, "name": "controllerid", "required": false, @@ -103178,47 +103296,47 @@ "related": "listElastistorVolume", "response": [ { - "description": "compression", - "name": "compression", + "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", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "synchronization", - "name": "sync", + "description": "Deduplication", + "name": "deduplication", "type": "string" }, + {}, { - "description": "the id of the volume", + "description": "graceallowed", + "name": "graceallowed", + "type": "string" + }, + { + "description": "The ID of the volume", "name": "id", "type": "string" }, { - "description": "the name of the volume", + "description": "The name of the volume", "name": "name", "type": "string" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "Synchronization", + "name": "sync", "type": "string" }, - {}, { - "description": "deduplication", - "name": "deduplication", + "description": "Compression", + "name": "compression", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -103226,6 +103344,20 @@ "isasync": false, "name": "quotaStatement", "params": [ + { + "description": "List quota usage records for the specified usage type", + "length": 255, + "name": "type", + "required": false, + "type": "integer" + }, + { + "description": "End of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, { "description": "Optional, Account Id for which statement needs to be generated", "length": 255, @@ -103234,11 +103366,11 @@ "type": "string" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "List usage records for the specified Account", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, "type": "uuid" }, { @@ -103249,77 +103381,63 @@ "type": "date" }, { - "description": "End of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "enddate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, - "type": "date" - }, - { - "description": "List quota usage records for the specified usage type", - "length": 255, - "name": "type", - "required": false, - "type": "integer" - }, - { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": false, "type": "uuid" } ], "related": "", "response": [ { - "description": "domain id", - "name": "domain", - "type": "long" - }, - { - "description": "usage unit", - "name": "unit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "usage type", + "description": "Usage type", "name": "type", "type": "int" }, { - "description": "account id", - "name": "accountid", + "description": "Domain id", + "name": "domain", "type": "long" }, - {}, { - "description": "usage type name", - "name": "name", + "description": "Account name", + "name": "account", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "Usage unit", + "name": "unit", "type": "string" }, + {}, + {}, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "Usage type name", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "Account id", + "name": "accountid", + "type": "long" + }, + { + "description": "Quota consumed", + "name": "quota", + "type": "bigdecimal" + } ], "since": "4.7.0" }, @@ -103329,15 +103447,15 @@ "name": "updateLBStickinessPolicy", "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 policy to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "id of lb stickiness policy", + "description": "ID of lb stickiness policy", "length": 255, "name": "id", "related": "createLBStickinessPolicy,updateLBStickinessPolicy", @@ -103345,110 +103463,110 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the policy 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": "createLBStickinessPolicy", "response": [ { - "description": "the list of stickinesspolicies", + "description": "The description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "The Account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "The LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "The state of the policy", + "name": "state", + "type": "string" + }, + {}, + {}, + { + "description": "The list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "The state of the policy", + "name": "state", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "The name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the params of the policy", + "description": "The params of the policy", "name": "params", "type": "map" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "The method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The LB Stickiness policy ID", + "name": "id", + "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "The description of the Stickiness policy", + "name": "description", "type": "string" }, { - "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 domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", + "description": "The domain of the Stickiness policy", "name": "domain", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, { - "description": "the name of the Stickiness policy", + "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 state of the policy", - "name": "state", + "description": "The domain ID of the Stickiness policy", + "name": "domainid", "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" - }, - {} + } ], "since": "4.4" }, @@ -103458,36 +103576,21 @@ "name": "listPods", "params": [ { - "description": "list Pods by Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list pods by allocation state", + "description": "Flag to display the capacity of the pods", "length": 255, - "name": "allocationstate", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list Pods by name", + "description": "List Pods by name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "list Pods by ID", + "description": "List Pods by ID", "length": 255, "name": "id", "related": "listPods,createManagementNetworkIpRange", @@ -103502,13 +103605,6 @@ "since": "4.21.0", "type": "string" }, - { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -103519,58 +103615,48 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - } - ], - "related": "createManagementNetworkIpRange", - "response": [ - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List pods by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone ID of the Pod", + "description": "List Pods by Zone ID", + "length": 255, "name": "zoneid", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" - }, + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createManagementNetworkIpRange", + "response": [ { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "The gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", - "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 gateway of the Pod", - "name": "gateway", + "description": "The Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { @@ -103579,153 +103665,185 @@ "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "The IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The CIDR for the range", + "name": "cidr", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "Indicates VLAN ID for the range", + "name": "vlanid", + "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 Zone ID", - "name": "zoneid", + "description": "The starting IP for the range", + "name": "startip", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "The capacity of the Pod", + "name": "capacity", + "response": [ { - "description": "the capacity name", + "description": "The capacity name", "name": "name", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Cluster ID", + "description": "The Cluster ID", "name": "clusterid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The Zone name", + "name": "zonename", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "The Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the Pod", + "description": "The netmask of the Pod", + "name": "netmask", + "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 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", "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The Zone name of the Pod", + "name": "zonename", + "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" } ] }, { - "description": "delete Tungsten-Fabric address group", + "description": "Delete Tungsten-Fabric address group", "isasync": true, "name": "deleteTungstenFabricAddressGroup", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -103733,7 +103851,7 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "The UUID of Tungsten-Fabric address group", "length": 255, "name": "addressgroupuuid", "required": true, @@ -103742,26 +103860,26 @@ ], "response": [ {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "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" } ] }, @@ -103770,6 +103888,14 @@ "isasync": false, "name": "quotaTariffList", "params": [ + { + "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", + "length": 255, + "name": "listall", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -103778,25 +103904,26 @@ "type": "string" }, { - "description": "The start date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, + "since": "4.18.0.0", "type": "date" }, { - "description": "", + "description": "If set to true, we will list only the removed tariffs. The default is false.", "length": 255, - "name": "pagesize", + "name": "listonlyremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to true, we will list only the removed tariffs. The default is false.", + "description": "", "length": 255, - "name": "listonlyremoved", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "Usage type of the resource", @@ -103806,26 +103933,25 @@ "type": "integer" }, { - "description": "", + "description": "The quota tariff's id.", "length": 255, - "name": "page", + "name": "id", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "", "length": 255, - "name": "enddate", + "name": "page", "required": false, - "since": "4.18.0.0", - "type": "date" + "type": "integer" }, { - "description": "The quota tariff's id.", + "description": "The start date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "id", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "The name of the quota tariff.", @@ -103834,104 +103960,96 @@ "required": false, "since": "4.18.0.0", "type": "string" - }, - { - "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", - "length": 255, - "name": "listall", - "required": false, - "since": "4.18.0.0", - "type": "boolean" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the ID of the tariff", - "name": "id", + "description": "Description", + "name": "description", "type": "string" }, + {}, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "The ID of the tariff", + "name": "id", "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "When the quota tariff was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the start date of the quota tariff", + "description": "The start date of the quota tariff", "name": "effectiveDate", "type": "date" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, - { - "description": "usageName", - "name": "usageName", + "description": "Name", + "name": "name", "type": "string" }, { - "description": "currency", + "description": "Currency", "name": "currency", "type": "string" }, - {}, - {}, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name", - "name": "name", + "description": "Usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" + "description": "The end date of the quota tariff", + "name": "endDate", + "type": "date" }, { - "description": "position in the execution sequence for tariffs of the same type", + "description": "Position in the execution sequence for tariffs of the same type", "name": "position", "type": "integer" }, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "usageUnit", + "name": "usageUnit", + "type": "string" }, { - "description": "description", - "name": "description", + "description": "Activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.7.0" @@ -103942,7 +104060,7 @@ "name": "stopKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "The ID of the Kubernetes cluster", "length": 255, "name": "id", "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", @@ -103951,27 +104069,27 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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" }, + {}, {} ] }, @@ -103991,143 +104109,255 @@ ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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.21.0" }, { - "description": "Adds account to a project", - "isasync": true, - "name": "addAccountToProject", + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", "params": [ { - "description": "email to which invitation to the project is going to be sent", + "description": "project who which the IPv4 subnet is dedicated to", "length": 255, - "name": "email", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "ID of the project role", + "description": "", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": false, "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "List by keyword", "length": 255, - "name": "roletype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "name of the account to be added to the project", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "ID of the project to add the account to", + "description": "CIDR of the IPv4 subnet.", "length": 255, - "name": "projectid", - "related": "createProject", - "required": true, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" } ], + "related": "dedicateIpv4SubnetForZone", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, - {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" } ], - "since": "3.0.0" + "since": "4.20.0" }, { - "description": "Lists all available snapshots for the account.", - "isasync": false, - "name": "listSnapshots", + "description": "Adds Account to a project", + "isasync": true, + "name": "addAccountToProject", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Email to which invitation to the project is going to be sent", "length": 255, - "name": "isrecursive", + "name": "email", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "Project role type to be assigned to the User - Admin/Regular; default: Regular", "length": 255, - "name": "page", + "name": "roletype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "Name of the Account to be added to the project", "length": 255, - "name": "locationtype", + "name": "account", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "ID of the project to add the Account to", "length": 255, - "name": "snapshottype", + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "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": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list snapshots by zone id", + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Lists all available snapshots for the account.", + "isasync": false, + "name": "listSnapshots", + "params": [ + { + "description": "The IDs of the Snapshots, mutually exclusive with id", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "lists snapshot by snapshot ID", + "description": "Lists Snapshot by Snapshot ID", "length": 255, "name": "id", "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", @@ -104135,41 +104365,55 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "intervaltype", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "List Snapshots by zone id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Lists Snapshot by Snapshot name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ids", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "tags", "required": false, - "since": "4.9", - "type": "list" + "type": "map" }, { - "description": "the ID of the disk volume", + "description": "ID of the storage pool", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.19", "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -104190,234 +104434,247 @@ "type": "string" }, { - "description": "", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "pagesize", + "name": "locationtype", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists snapshot by snapshot name", + "description": "The ID of the disk volume", "length": 255, - "name": "name", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list templates across zones and their storages", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showunique", + "name": "isrecursive", "required": false, - "since": "4.19.0", "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 objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list templates across zones and their storages", + "length": 255, + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Valid values are MANUAL or RECURRING.", "length": 255, - "name": "account", + "name": "snapshottype", "required": false, "type": "string" }, { - "description": "ID of the storage pool", + "description": "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "intervaltype", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "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": "Name of the Snapshot", + "name": "name", + "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": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "Name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "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", + "description": "The type of the Snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "Display name of the os on volume", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "The domain name of the Snapshot's Account", + "name": "domain", "type": "string" }, + {}, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "The parent ID of the Snapshot", + "name": "parent", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "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 backed up Snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "type of the disk volume", + "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 domain ID of the Snapshot's Account", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" } @@ -104425,325 +104682,201 @@ "type": "set" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, + {}, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "name of the snapshot", - "name": "name", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "valid location types are primary and secondary.", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "Valid location types are primary and secondary.", "name": "locationtype", "type": "string" }, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", + "description": "The project name of the Snapshot", + "name": "project", + "type": "string" + }, + { + "description": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "ID of the Snapshot", + "name": "id", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The project id of the Snapshot", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The parent name of the Snapshot", + "name": "parentname", + "type": "string" } ] }, { - "description": "Lists IPv4 subnets for zone.", + "description": "Delete the extensions", "isasync": false, - "name": "listIpv4SubnetsForZone", + "name": "deleteExtension", "params": [ { - "description": "the account which the IPv4 subnet is dedicated to. 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": "the domain ID which the IPv4 subnet is dedicated to.", + "description": "Whether to cleanup files for the extension. If true, the extension files will be deleted from all the management servers.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "cleanup", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "UUID of the IPv4 subnet.", + "description": "ID of the extension", "length": 255, "name": "id", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "project who which the IPv4 subnet is dedicated to", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "listZones", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, "type": "uuid" - }, - { - "description": "CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "dedicateIpv4SubnetForZone", + "related": "listExtensions,updateExtension,unregisterExtension", "response": [ + {}, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", + "description": "Creation timestamp of the extension", "name": "created", "type": "date" }, - {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + } + ], + "type": "list" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "Type of the extension", + "name": "type", "type": "string" }, + {}, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "Name of the extension", + "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the IPv4 subnet", - "name": "project", - "type": "string" + "description": "The details of the extension", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" - }, - { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", "type": "string" }, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Delete the extensions", - "isasync": false, - "name": "deleteExtension", - "params": [ { "description": "ID of the extension", - "length": 255, "name": "id", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", - "required": false, - "type": "uuid" - }, - { - "description": "Whether to cleanup files for the extension. If true, the extension files will be deleted from all the management servers.", - "length": 255, - "name": "cleanup", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", - "required": false, - "type": "boolean" - } - ], - "related": "listExtensions,updateExtension,unregisterExtension", - "response": [ - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - {}, - {}, - { - "description": "Type of the extension", - "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 extension", - "name": "name", "type": "string" }, { - "description": "Creation timestamp of the extension", - "name": "created", + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", "type": "date" }, { - "description": "The path of the entry point fo the extension", - "name": "path", - "type": "string" - }, - { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", + "description": "True if the extension is added by admin", + "name": "isuserdefined", "type": "boolean" }, - { - "description": "Description of the extension", - "name": "description", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "The state of the extension", "name": "state", "type": "string" }, { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, - {}, - { - "description": "List of resources to which extension is registered to", - "name": "resources", - "response": [ - { - "description": "ID of the resource associated with the extension", - "name": "id", - "type": "string" - }, - { - "description": "Name of the resource associated with this mapping", - "name": "name", - "type": "string" - }, - { - "description": "the details of the resource map", - "name": "details", - "type": "map" - }, - { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" - }, - { - "description": "Type of the resource", - "name": "type", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "ID of the extension", - "name": "id", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" } ], "since": "4.21.0" @@ -104753,6 +104886,14 @@ "isasync": true, "name": "migrateResourceToAnotherSecondaryStorage", "params": [ + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, { "description": "id(s) of the snapshots to be migrated", "length": 255, @@ -104761,14 +104902,6 @@ "required": false, "type": "list" }, - { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", - "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": true, - "type": "uuid" - }, { "description": "id(s) of the templates to be migrated", "length": 255, @@ -104778,9 +104911,9 @@ "type": "list" }, { - "description": "id of the image store from where the data is to be migrated", + "description": "id of the destination secondary storage pool to which the resources are to be migrated", "length": 255, - "name": "srcpool", + "name": "destpool", "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" @@ -104789,31 +104922,31 @@ "related": "migrateSecondaryStorageData", "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "Type of migration requested for", - "name": "migrationtype", - "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + }, { "description": "Response message from migration of secondary storage data objects", "name": "message", "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.0" @@ -104824,21 +104957,15 @@ "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.", + "description": "The domain ID associated with the keypair", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the project associated with keypair", + "description": "The project associated with keypair", "length": 255, "name": "projectid", "related": "createProject", @@ -104846,33 +104973,39 @@ "type": "uuid" }, { - "description": "the domain ID associated with the keypair", + "description": "Name of the keypair", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The Account associated with the keypair. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", + "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", + "description": "True 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -104884,10 +105017,18 @@ "isasync": false, "name": "searchLdap", "params": [ + { + "description": "Query to search using", + "length": 255, + "name": "query", + "related": "searchLdap", + "required": true, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -104898,18 +105039,10 @@ "required": false, "type": "string" }, - { - "description": "query to search using", - "length": 255, - "name": "query", - "related": "searchLdap", - "required": true, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -104917,8 +105050,13 @@ "related": "", "response": [ { - "description": "The user's email", - "name": "email", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, { @@ -104931,37 +105069,32 @@ "name": "domain", "type": "string" }, - { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", - "type": "string" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The user's firstname", "name": "firstname", "type": "string" }, - {}, { - "description": "The user's username", - "name": "username", + "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 user's username", + "name": "username", "type": "string" }, { "description": "The user's principle", "name": "principal", "type": "string" + }, + {}, + { + "description": "The user's email", + "name": "email", + "type": "string" } ], "since": "4.2.0" @@ -104972,7 +105105,7 @@ "name": "readyForShutdown", "params": [ { - "description": "the id of the management server", + "description": "The UUID of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", @@ -104983,31 +105116,26 @@ "related": "prepareForShutdown", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, - {}, { "description": "The host agents this management server is responsible for", "name": "agents", "type": "list" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The number of host agents this management server is responsible for", "name": "agentscount", "type": "long" }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" - }, + {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", @@ -105015,88 +105143,93 @@ }, {}, { - "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 management server", + "name": "managementserverid", "type": "string" }, { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.0" }, { - "description": "create Tungsten-Fabric logical router", + "description": "Create Tungsten-Fabric logical router", "isasync": true, "name": "createTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric logical router name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric logical router name", + "description": "The ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, - {}, - { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" - }, { - "description": "list Tungsten-Fabric policy network name", + "description": "List Tungsten-Fabric policy network name", "name": "network", "type": "list" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } + }, + {} ] }, { @@ -105121,19 +105254,25 @@ "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, + {}, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "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": "the bytes allocated", @@ -105141,70 +105280,49 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - {}, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { "description": "path of the domain to which the shared filesystem", @@ -105217,19 +105335,19 @@ "type": "long" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, + {}, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, - {}, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { @@ -105237,341 +105355,355 @@ "name": "nic", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", + "description": "Name of the VPC to which the NIC belongs", "name": "vpcname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 ID of the corresponding Network", + "name": "networkid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" } ], "type": "list" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "set" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" } ], "since": "4.20.0" }, { - "description": "create Tungsten-Fabric firewall", + "description": "Create Tungsten-Fabric firewall", "isasync": true, "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "srcaddressgroupuuid", + "required": false, + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "name": "srctaguuid", + "required": false, "type": "string" }, { @@ -105582,90 +105714,86 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "The uuid of Tungsten-Fabric destination network", "length": 255, - "name": "servicegroupuuid", - "required": true, + "name": "destnetworkuuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "The ID of zone", "length": 255, - "name": "srctaguuid", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "srcnetworkuuid", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "The sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "name", + "name": "sequence", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "destnetworkuuid", - "required": false, + "name": "direction", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "tagtypeuuid", + "name": "desttaguuid", "required": false, "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "sequence", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "srcaddressgroupuuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "The UUID of Tungsten-Fabric firewall policy", "length": 255, - "name": "action", + "name": "firewallpolicyuuid", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "direction", - "required": true, + "name": "tagtypeuuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "The UUID of Tungsten-Fabric source network", "length": 255, - "name": "desttaguuid", + "name": "srcnetworkuuid", "required": false, "type": "string" } ], "related": "listTungstenFabricFirewallRule", "response": [ - { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "type": "string" - }, { "description": "Tungsten-Fabric firewall rule action", "name": "action", @@ -105676,22 +105804,11 @@ "name": "srctag", "type": "string" }, - {}, - { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" - }, { "description": "Tungsten-Fabric firewall rule destination tag", "name": "desttag", "type": "string" }, - { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", - "type": "string" - }, { "description": "Tungsten-Fabric firewall rule destination address group", "name": "destaddressgroup", @@ -105702,30 +105819,45 @@ "name": "destnetwork", "type": "string" }, + { + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -105734,15 +105866,16 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" - } + }, + {} ] }, { @@ -105751,20 +105884,13 @@ "name": "listConfigurations", "params": [ { - "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": "createDomain,listDomains,listDomains", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -105773,15 +105899,22 @@ "type": "integer" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "The ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "Lists configurations by category", + "length": 255, + "name": "category", + "required": false, + "type": "string" + }, + { + "description": "The ID of the Account to update the parameter value for corresponding account", "length": 255, "name": "accountid", "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", @@ -105789,15 +105922,14 @@ "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "Lists configuration by name", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "Lists configuration by parent name (primarily used for UI)", "length": 255, "name": "parent", "required": false, @@ -105812,48 +105944,49 @@ "type": "integer" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", + "description": "List by keyword", "length": 255, - "name": "subgroup", + "name": "keyword", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "lists configurations by category", + "description": "The ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "category", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists configuration by name", + "description": "Lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "name", + "name": "subgroup", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "Lists configuration by group name (primarily used for UI)", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "group", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "The ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "group", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.18.0", - "type": "string" + "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": "listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" } @@ -105861,89 +105994,89 @@ "related": "", "response": [ { - "description": "the category of the configuration", - "name": "category", + "description": "The subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "The component of the configuration", + "name": "component", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "The display text of the configuration", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the group of the configuration", - "name": "group", + "description": "The default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The category of the configuration", + "name": "category", + "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "The name of the parent configuration", + "name": "parent", "type": "string" }, {}, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "The description of the configuration", + "name": "description", "type": "string" }, - {}, { - "description": "the value of the configuration", + "description": "The value of the configuration", "name": "id", "type": "long" }, { - "description": "the description of the configuration", - "name": "description", + "description": "Scope (zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the 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 default value of the configuration", - "name": "defaultvalue", + "description": "The value of the configuration", + "name": "value", "type": "string" }, { - "description": "true if the configuration is dynamic", + "description": "True if the configuration is dynamic", "name": "isdynamic", "type": "boolean" }, { - "description": "the component of the configuration", - "name": "component", + "description": "The group of the configuration", + "name": "group", "type": "string" }, { - "description": "the possible options of the configuration value", + "description": "The possible options of the configuration value", "name": "options", "type": "string" }, { - "description": "the type of the configuration value", + "description": "The type of the configuration value", "name": "type", "type": "string" } @@ -105955,15 +106088,29 @@ "name": "scaleKubernetesCluster", "params": [ { - "description": "the IDs of the nodes to be removed", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "nodeids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "autoscalingenabled", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "The ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "Number of Kubernetes cluster nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "The ID of the service offering for the virtual machines in the cluster.", "length": 255, "name": "serviceofferingid", "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", @@ -105971,11 +106118,11 @@ "type": "uuid" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "autoscalingenabled", + "name": "maxsize", "required": false, - "type": "boolean" + "type": "long" }, { "description": "Minimum number of worker nodes in the cluster", @@ -105985,19 +106132,12 @@ "type": "long" }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "description": "Maximum number of worker nodes in the cluster", + "description": "The IDs of the nodes to be removed", "length": 255, - "name": "maxsize", + "name": "nodeids", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "long" + "type": "list" }, { "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", @@ -106006,45 +106146,33 @@ "required": false, "since": "4.21.0", "type": "map" - }, - { - "description": "number of Kubernetes cluster nodes", - "length": 255, - "name": "size", - "required": false, - "type": "long" } ], "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "The name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "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 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": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, { @@ -106053,23 +106181,28 @@ "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "The state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" + }, + { + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "The Account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { @@ -106078,90 +106211,74 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "The name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", + "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": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "The cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "The description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "The name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", @@ -106169,104 +106286,120 @@ "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "The name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", + "description": "The list of virtualmachines associated with this Kubernetes cluster", "name": "virtualmachines", "type": "list" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", - "type": "string" - }, - {}, + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", - "type": "string" + "description": "The size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "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 master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + {}, + { + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "The memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "The ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" } ] @@ -106277,7 +106410,7 @@ "name": "stopNetScalerVpx", "params": [ { - "description": "the ID of the NetScaler vm", + "description": "The ID of the NetScaler vm", "length": 255, "name": "id", "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", @@ -106295,490 +106428,490 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the first DNS for the router", + "description": "The first DNS for the router", "name": "dns1", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host ID for the router", - "name": "hostid", + "description": "The Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The Network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod name for the router", + "description": "The Pod name for the router", "name": "podname", "type": "string" }, + {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of VPC the router belongs to", + "description": "The name of VPC the router belongs to", "name": "vpcname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "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 version of template", - "name": "version", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", + "description": "The first IPv6 DNS for the router", "name": "ip6dns1", "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 guest MAC address for the router", - "name": "guestmacaddress", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding link local network", + "description": "The ID of the corresponding link local Network", "name": "linklocalnetworkid", "type": "string" }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, { "description": "path of the Domain the router belongs to", "name": "domainpath", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", + "description": "The ID of the service offering of the Instance", "name": "serviceofferingid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "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", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The host ID for the router", + "name": "hostid", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", + "description": "The hypervisor on which the Template runs", "name": "hypervisor", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the router", + "description": "The name of the router", "name": "name", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "Role of the domain router", + "name": "role", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The ID of the router", + "name": "id", "type": "string" }, + {}, { - "description": "the Pod ID for the router", + "description": "The Pod ID for the router", "name": "podid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "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 date and time the router was created", - "name": "created", - "type": "date" + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "The list of NICs associated with the router", + "name": "nic", "response": [ { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "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": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The IPv6 address of Network", + "name": "ip6address", "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": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "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" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the Instance 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 Instance", + "name": "ipaddresses", "type": "list" }, { - "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 gateway of the nic", - "name": "gateway", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + } + ], + "type": "set" + }, + { + "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 guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "The version of Template", + "name": "version", + "type": "string" + }, + { + "description": "The Template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "The result of the health check if available", + "name": "success", "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "The project id of the IP address", + "name": "projectid", + "type": "string" + }, + { + "description": "The control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The Template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "The public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "The version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "The link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "The guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the domain associated with the router", + "description": "The domain associated with the router", "name": "domain", "type": "string" + }, + { + "description": "The public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "The Control IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "The public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "The domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "The state of the router", + "name": "state", + "type": "state" + }, + { + "description": "The Account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" } ] }, { - "description": "Deletes a vm group", + "description": "Deletes an Instance group", "isasync": false, "name": "deleteInstanceGroup", "params": [ { - "description": "the ID of the instance group", + "description": "The ID of the Instance group", "length": 255, "name": "id", "related": "updateInstanceGroup", @@ -106788,26 +106921,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", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -106817,9 +106950,9 @@ "name": "updateTrafficType", "params": [ { - "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" }, @@ -106831,19 +106964,18 @@ "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": "traffic type id", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "xennetworklabel", + "required": false, + "type": "string" }, { "description": "The network name label of the physical device dedicated to this traffic on a KVM host", @@ -106853,94 +106985,97 @@ "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "Traffic type ID", "length": 255, - "name": "ovm3networklabel", - "required": false, - "type": "string" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" } ], "related": "addTrafficType", "response": [ { - "description": "id of the network provider", - "name": "id", + "description": "The Network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, {}, { - "description": "The 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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 XenServer host", - "name": "xennetworklabel", + "description": "The trafficType to be added to the physical Network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "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 HyperV host", + "description": "The Network name label of the physical device dedicated to this traffic on a HyperV host", "name": "hypervnetworklabel", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "3.0.0" }, { - "description": "List Conditions for VM auto scaling", + "description": "List Conditions for Instance auto scaling", "isasync": false, "name": "listConditions", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "ID of the Condition.", "length": 255, - "name": "listall", + "name": "id", + "related": "listConditions", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the policy", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -106953,11 +107088,19 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "The ID of the policy", "length": 255, - "name": "keyword", + "name": "policyid", + "related": "listAutoScalePolicies", "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" }, { "description": "", @@ -106967,105 +107110,80 @@ "type": "integer" }, { - "description": "ID of the Condition.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listConditions", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "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", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "zone id of counter", + "description": "Zone ID of counter", "name": "zoneid", "type": "string" }, - { - "description": "the project name of the Condition", - "name": "project", - "type": "string" - }, {}, { - "description": "the Name of the Counter.", + "description": "The Name of the Counter.", "name": "countername", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "The owner of the Condition.", + "name": "account", + "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "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 project name of the Condition", + "name": "project", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "The ID of the Counter.", + "name": "counterid", + "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "The domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -107073,15 +107191,30 @@ "name": "domainpath", "type": "string" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, {}, { - "description": "the owner of the Condition.", - "name": "account", + "description": "The project ID of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The domain ID of the Condition owner", + "name": "domainid", "type": "string" } ] @@ -107091,6 +107224,13 @@ "isasync": false, "name": "addBackupRepository", "params": [ + { + "description": "capacity of this backup repository", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, { "description": "backups on this repository can be used to create Instances on all Zones", "length": 255, @@ -107100,19 +107240,12 @@ "type": "boolean" }, { - "description": "address of the backup repository", + "description": "name of the backup repository", "length": 255, - "name": "address", + "name": "name", "required": true, "type": "string" }, - { - "description": "shared storage mount options", - "length": 255, - "name": "mountopts", - "required": false, - "type": "string" - }, { "description": "ID of the zone where the backup repository is to be added for taking backups", "length": 255, @@ -107122,24 +107255,24 @@ "type": "uuid" }, { - "description": "backup repository provider", + "description": "address of the backup repository", "length": 255, - "name": "provider", - "required": false, + "name": "address", + "required": true, "type": "string" }, { - "description": "capacity of this backup repository", + "description": "backup repository provider", "length": 255, - "name": "capacitybytes", + "name": "provider", "required": false, - "type": "long" + "type": "string" }, { - "description": "name of the backup repository", + "description": "shared storage mount options", "length": 255, - "name": "name", - "required": true, + "name": "mountopts", + "required": false, "type": "string" }, { @@ -107152,39 +107285,50 @@ ], "related": "", "response": [ + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the address / url of the backup repository", "name": "address", "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 backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, { "description": "the ID of the backup repository", "name": "id", "type": "string" }, { - "description": "the Zone ID of the backup repository", - "name": "zoneid", + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, { - "description": "the date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "the Zone ID of the backup repository", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the name of the backup repository", + "name": "name", "type": "string" }, { @@ -107192,33 +107336,27 @@ "name": "type", "type": "string" }, + {}, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" - }, - { - "description": "the name of the backup repository", - "name": "name", + "description": "mount options", + "name": "mountopts", "type": "string" }, { - "description": "the Zone name of the backup repository", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the backups in this repository can be used to create Instances on all Zones", - "name": "crosszoneinstancecreation", - "type": "boolean" + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" } ], "since": "4.20.0" }, { - "description": "migrates data objects from one secondary storage to destination image store(s)", + "description": "Migrates data objects from one secondary storage to destination image store(s)", "isasync": true, "name": "migrateSecondaryStorageData", "params": [ @@ -107230,7 +107368,7 @@ "type": "string" }, { - "description": "id of the image store from where the data is to be migrated", + "description": "ID of the image store from where the data is to be migrated", "length": 255, "name": "srcpool", "related": "addSecondaryStorage,listSwifts,addImageStore", @@ -107238,7 +107376,7 @@ "type": "uuid" }, { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "description": "ID(s) of the destination secondary storage pool(s) to which the Templates are to be migrated", "length": 255, "name": "destpools", "related": "addSecondaryStorage,listSwifts,addImageStore", @@ -107249,31 +107387,31 @@ "related": "", "response": [ { - "description": "Type of migration requested for", - "name": "migrationtype", - "type": "string" - }, - { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" } ], "since": "4.15.0" @@ -107283,14 +107421,6 @@ "isasync": true, "name": "destroyVolume", "params": [ - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - }, { "description": "If true is passed, the volume is expunged immediately. False by default.", "length": 255, @@ -107298,433 +107428,441 @@ "required": false, "since": "4.6.0", "type": "boolean" - } - ], - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "response": [ - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" }, { - "description": "ID of the disk volume", + "description": "The ID of the volume", + "length": 255, "name": "id", - "type": "string" - }, - { - "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", + "description": "The name of the ISO attached to the Instance", "name": "isoname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "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", + "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", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", "name": "storageid", "type": "string" }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, { "description": "true if volume has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "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": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", + "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": "customer associated with the tag", + "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": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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": "True if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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 Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "The disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The Account associated with the disk volume", + "name": "account", "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": "ID of the disk offering", - "name": "diskofferingid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "Max IOPS of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the display text of the service offering for root disk", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "The display text of the service offering for root disk", "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "description": "The ID of the device on User Instance the volume is attached 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": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "State of the Instance", + "name": "vmstate", + "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": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "Size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "The project name of the VPN", + "name": "project", + "type": "string" + }, + { + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "The path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Name of the Instance", + "name": "vmname", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" } ], "since": "4.14.0" @@ -107735,31 +107873,23 @@ "name": "addTrafficType", "params": [ { - "description": "the Physical Network ID", + "description": "The trafficType to be added to the physical network", "length": 255, - "name": "physicalnetworkid", - "related": "updatePhysicalNetwork", + "name": "traffictype", "required": true, - "type": "uuid" - }, - { - "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 trafficType to be added to the physical network", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "traffictype", - "required": true, + "name": "xennetworklabel", + "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" }, @@ -107771,16 +107901,16 @@ "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": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "isolationmethod", + "name": "ovm3networklabel", "required": false, "type": "string" }, @@ -107792,9 +107922,17 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The Physical Network ID", "length": 255, - "name": "kvmnetworklabel", + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "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" } @@ -107802,57 +107940,57 @@ "related": "", "response": [ { - "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 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", + "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 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 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 VMware host", - "name": "vmwarenetworklabel", + "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 trafficType to be added to the physical Network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "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", + "description": "The Network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -107862,18 +108000,11 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "Show removed heuristics.", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -107890,11 +108021,18 @@ "type": "integer" }, { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "Show removed heuristics.", "length": 255, - "name": "type", + "name": "showremoved", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "The zone ID to be used in the search filter.", @@ -107907,75 +108045,75 @@ ], "related": "", "response": [ - {}, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", + "description": "When the heuristic was created.", + "name": "created", "type": "date" }, + {}, { "description": "Description of the heuristic.", "name": "description", "type": "string" }, + {}, { "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "name": "type", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" }, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, - {}, - { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" - }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" } ], "since": "4.19.0" }, { - "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "description": "List all Instances that are assigned to a load balancer rule.", "isasync": false, "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "List by keyword", "length": 255, - "name": "lbvmips", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "id", "related": "createPortForwardingRule,updatePortForwardingRule", @@ -107983,16 +108121,9 @@ "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "True if load balancer rule Instance IP information to be included; default is false", "length": 255, - "name": "applied", + "name": "lbvmips", "required": false, "type": "boolean" }, @@ -108003,6 +108134,13 @@ "required": false, "type": "integer" }, + { + "description": "True if listing all Instances currently applied to the load balancer rule; default is true", + "length": 255, + "name": "applied", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -108014,36 +108152,36 @@ "related": "listLoadBalancerRuleInstances", "response": [ { - "description": "the user vm set for lb rule", + "description": "The user Instance set for LB rule", "name": "loadbalancerruleinstance", "type": "uservmresponse" }, { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IP addresses of the Instance set of LB rule", + "name": "lbvmipaddresses", + "type": "list" } ] }, { - "description": "Removes a condition for VM auto scaling", + "description": "Removes a condition for Instance auto scaling", "isasync": true, "name": "deleteCondition", "params": [ { - "description": "the ID of the condition.", + "description": "The ID of the condition.", "length": 255, "name": "id", "related": "", @@ -108053,27 +108191,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "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", + "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" + } ] }, { @@ -108082,33 +108220,33 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "the VLAN for the physical network", + "description": "The speed for the physical Network[1G/10G]", "length": 255, - "name": "vlan", + "name": "networkspeed", "required": false, "type": "string" }, { - "description": "physical network id", + "description": "The VLAN for the physical Network", "length": 255, - "name": "id", - "related": "updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "string" }, { - "description": "Tag the physical network", + "description": "Tag the physical Network", "length": 255, "name": "tags", "required": false, "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "Physical Network ID", "length": 255, - "name": "networkspeed", - "required": false, - "type": "string" + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { "description": "Enabled/Disabled", @@ -108121,72 +108259,72 @@ "related": "", "response": [ { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "Name of the physical Network", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "Comma separated tag", + "name": "tags", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "The VLAN of the physical Network", + "name": "vlan", "type": "string" }, { - "description": "Broadcast domain range of the physical network", + "description": "Broadcast domain range of the physical Network", "name": "broadcastdomainrange", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "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": "The speed of the physical Network", + "name": "networkspeed", "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 domain id of the physical network owner", - "name": "domainid", + "description": "The UUID of the physical Network", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone name of the physical Network", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "Zone ID of the physical Network", + "name": "zoneid", "type": "string" }, + {}, { - "description": "comma separated tag", - "name": "tags", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "State of the physical Network", + "name": "state", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -108214,311 +108352,225 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Name of the availability zone", - "name": "zonename", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, { "description": "Network ID of the shared filesystem", "name": "networkid", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of the nic", + "description": "The gateway of the NIC", "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The netmask of the NIC", "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", + "description": "The Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", + "description": "ID of the VPC to which the NIC belongs", "name": "vpcid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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 (if NSX based), null otherwise", "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The 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 traffic type of the nic", - "name": "traffictype", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", + "description": "The CIDR of IPv6 Network", "name": "ip6cidr", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The ID of the NIC", + "name": "id", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" } ], "type": "list" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { @@ -108526,128 +108578,214 @@ "name": "volumename", "type": "string" }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "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", + "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", + "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": "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", + "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": "id of the resource", - "name": "resourceid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, { "description": "the disk utilization", "name": "utilization", "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + {}, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" } ], "since": "4.20.0" @@ -108658,18 +108796,19 @@ "name": "createVgpuProfile", "params": [ { - "description": "the maximum Y resolution", + "description": "the GPU card ID associated with this GPU device", "length": 255, - "name": "maxresolutiony", - "required": false, - "type": "long" + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the name of the vGPU profile", + "description": "Max vGPU per physical GPU. This is used to calculate capacity.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" }, { "description": "the description of the vGPU profile", @@ -108679,16 +108818,16 @@ "type": "string" }, { - "description": "Max vGPU per physical GPU. This is used to calculate capacity.", + "description": "the maximum X resolution", "length": 255, - "name": "maxvgpuperphysicalgpu", + "name": "maxresolutionx", "required": false, "type": "long" }, { - "description": "the maximum X resolution", + "description": "the maximum Y resolution", "length": 255, - "name": "maxresolutionx", + "name": "maxresolutiony", "required": false, "type": "long" }, @@ -108700,12 +108839,11 @@ "type": "long" }, { - "description": "the GPU card ID associated with this GPU device", + "description": "the name of the vGPU profile", "length": 255, - "name": "gpucardid", - "related": "", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the maximum number of display heads", @@ -108718,9 +108856,24 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { "description": "the name of the vGPU profile", @@ -108728,13 +108881,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "the device ID of the GPU card", - "name": "deviceid", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { @@ -108743,28 +108896,25 @@ "type": "string" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, + {}, + {}, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the vGPU profile", - "name": "description", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { @@ -108773,42 +108923,30 @@ "type": "long" }, { - "description": "the ID of the GPU card", - "name": "id", - "type": "string" - }, - { - "description": "the device name of the GPU card", - "name": "devicename", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - {}, - {} + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + } ], "since": "4.21.0" }, { - "description": "create Tungsten-Fabric management network", + "description": "Create Tungsten-Fabric management network", "isasync": false, "name": "createTungstenFabricManagementNetwork", "params": [ { - "description": "the ID of pod", + "description": "The ID of pod", "length": 255, "name": "podid", "related": "createManagementNetworkIpRange", @@ -108817,63 +108955,55 @@ } ], "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "list Tungsten-Fabric firewall rule", + "description": "List Tungsten-Fabric firewall rule", "isasync": false, "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "The uuid of Tungsten-Fabric firewall rule", "length": 255, "name": "firewallruleuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "The uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "firewallpolicyuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -108883,40 +109013,33 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "List by keyword", "length": 255, - "name": "firewallpolicyuuid", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "The ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, {}, { "description": "Tungsten-Fabric firewall rule service group", @@ -108924,13 +109047,8 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -108939,18 +109057,23 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric firewall rule source address group", "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { @@ -108959,21 +109082,36 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric firewall rule uuid", "name": "uuid", "type": "string" }, - {} + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" + } ] }, { @@ -108982,11 +109120,11 @@ "name": "listNetrisProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -108996,11 +109134,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "ID of the zone", @@ -109014,23 +109152,23 @@ "related": "deleteNetrisProvider", "response": [ { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Provider name", + "name": "name", "type": "string" }, { - "description": "Netris Provider site", - "name": "sitename", + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" }, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { - "description": "Netris Provider URL", - "name": "netrisurl", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -109039,11 +109177,10 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, - {}, { "description": "Netris Tag for vNets", "name": "netristag", @@ -109051,19 +109188,20 @@ }, {}, { - "description": "Netris provider uuid", - "name": "uuid", - "type": "string" - }, + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "Netris Provider name", - "name": "name", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", + "type": "string" } ], "since": "4.21.0" @@ -109074,14 +109212,14 @@ "name": "createProject", "params": [ { - "description": "account who will be Admin for the project", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "description": "User ID of the Account to be assigned as owner of the project i.e., Project Admin", "length": 255, "name": "userid", "related": "disableUser,getUser,listUsers,lockUser", @@ -109090,305 +109228,263 @@ "type": "uuid" }, { - "description": "ID of the account owning a project", + "description": "Domain ID of the Account owning a project", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "domain ID of the account owning a project", + "description": "ID of the Account owning a project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, "type": "uuid" }, { - "description": "The display text of the project, defaults to the 'name´.", + "description": "Name of the project", "length": 255, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "name of the project", + "description": "Account who will be Admin for the project", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "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 name of the project", - "name": "name", + "description": "The total number of Instances that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "The total number of Instances available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "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 total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "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 memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "The displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "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 CPU cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "The total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "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 secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of gpus owned by project", + "name": "gputotal", + "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", + "description": "The total number of Instances running for this project", + "name": "vmrunning", "type": "integer" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the total number of gpus available to be created for this project", "name": "gpuavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "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", + "description": "The total number of CPU cores the project can own", + "name": "cpulimit", "type": "string" }, + { + "description": "The total number of VPCs owned by project", + "name": "vpctotal", + "type": "long" + }, { "description": "the total number of buckets available to this project", "name": "bucketavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "The total number of Snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "The total number of VPCs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "The total number of CPU cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the list of resource tags associated with vm", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "The total number of public IP addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "The total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "The total number of Snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of 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 snapshots stored by this project", - "name": "snapshottotal", + "description": "The total number of Instances stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" + }, + { + "description": "The total number of Instances deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "The total number of public IP addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "The total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "The total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "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", + "description": "The total number of Networks the project can own", + "name": "networklimit", "type": "string" }, { @@ -109397,107 +109493,149 @@ "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "The domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "The name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "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 number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "The total number of Snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", - "type": "string" - }, - { - "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 total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "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 tagged resource limit and count for the project", "name": "taggedresources", "type": "list" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "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) the project can own", - "name": "primarystoragelimit", + "description": "The total number of VPCs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" + "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 memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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 list of resource tags associated with Instance", + "name": "tags", + "response": [ + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "The total number of Networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the project account name of the project", + "description": "The project Account name of the project", "name": "projectaccountname", "type": "string" } @@ -109510,10 +109648,10 @@ "name": "assignCertToLoadBalancer", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the certificate", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule", + "name": "certid", + "related": "", "required": true, "type": "uuid" }, @@ -109526,36 +109664,36 @@ "type": "boolean" }, { - "description": "the ID of the certificate", + "description": "The ID of the load balancer rule", "length": 255, - "name": "certid", - "related": "", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -109572,7 +109710,14 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -109585,13 +109730,6 @@ "name": "hostname", "required": true, "type": "string" - }, - { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "password", - "required": true, - "type": "string" } ], "related": "listCiscoVnmcResources", @@ -109600,19 +109738,19 @@ {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, {}, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -109629,124 +109767,145 @@ "type": "string" }, { - "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": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" }, { - "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,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } ], "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ + { + "description": "The state of the account", + "name": "state", + "type": "string" + }, {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "True if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "The name of the Account", + "name": "name", + "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "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 total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "The list of ACL groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The default zone of the Account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the 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 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 number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The total number of VPCs the Account can own", + "name": "vpclimit", "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": "name of the Domain the account belongs to", - "name": "domain", + "description": "The total number of VPCs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + { + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + {}, { "description": "The tagged resource limit and count for the account", "name": "taggedresources", "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", + "type": "string" }, { "description": "the total number of backups stored by this account", @@ -109754,370 +109913,330 @@ "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "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 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 Instances running for this Account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "The total number of Snapshots stored by this Account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "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": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "The total number of CPU cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", + "description": "Path of the Domain the Account belongs to", "name": "domainpath", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "The total volume available for this Account", + "name": "volumeavailable", "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 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 total number of networks the account can own", - "name": "networklimit", + "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 virtual machines deployed by this account", + "description": "The total number of Instances deployed by this Account", "name": "vmtotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "The total number of Templates which can be created by this Account", + "name": "templatelimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "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 total number of public IP addresses available for this Account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the list of users associated with account", + "description": "The list of users associated with account", "name": "user", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The user email address", + "name": "email", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", + "description": "True if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "The domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user state", + "description": "The user state", "name": "state", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", + "description": "True if user has two factor authentication is mandated", "name": "is2famandated", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "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 date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the user ID", - "name": "id", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" } ], "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "The total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { @@ -110126,141 +110245,160 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "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 virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "The date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, { - "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 backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "The ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The total number of projects the Account can own", + "name": "projectlimit", "type": "string" + }, + { + "description": "The total number of projects being administrated by this Account", + "name": "projecttotal", + "type": "long" } ], "since": "4.0" }, { - "description": "Revokes certificate using configured CA plugin", + "description": "Deletes a routing firewall rule", "isasync": true, - "name": "revokeCertificate", + "name": "deleteRoutingFirewallRule", "params": [ { - "description": "The certificate serial number, as a hex value", + "description": "the ID of the Routing firewall rule", "length": 255, - "name": "serial", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, - "type": "string" - }, - { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "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" + "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ], - "since": "4.11.0" + "since": "4.20.0" }, { - "description": "Deletes a routing firewall rule", + "description": "Revokes certificate using configured CA plugin", "isasync": true, - "name": "deleteRoutingFirewallRule", + "name": "revokeCertificate", "params": [ { - "description": "the ID of the Routing firewall rule", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule", + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" } ], "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], - "since": "4.20.0" + "since": "4.11.0" }, { "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", @@ -110268,7 +110406,7 @@ "name": "changeServiceForSystemVm", "params": [ { - "description": "The ID of the system vm", + "description": "The ID of the System VM", "length": 255, "name": "id", "related": "startSystemVm,changeServiceForSystemVm", @@ -110276,7 +110414,7 @@ "type": "uuid" }, { - "description": "the service offering ID to apply to the system vm", + "description": "The service offering ID to apply to the System VM", "length": 255, "name": "serviceofferingid", "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", @@ -110284,7 +110422,7 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, "name": "details", "required": false, @@ -110294,211 +110432,211 @@ "related": "startSystemVm", "response": [ { - "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 ID of the system VM", - "name": "id", + "description": "The Template name for the System VM", + "name": "templatename", "type": "string" }, + {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "The Pod name for the System VM", + "name": "podname", "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "The state of the System VM", + "name": "state", "type": "string" }, - {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "The name of the System VM", + "name": "name", "type": "string" }, { - "description": "the 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", + "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The public MAC address for the System VM", + "name": "publicmacaddress", "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", - "name": "publicip", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "The date and time the System VM was created", + "name": "created", + "type": "date" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "The agent state of the System VM", + "name": "agentstate", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The Zone name for the System VM", + "name": "zonename", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "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": "CPU arch of the system VM", - "name": "arch", + "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 Pod ID for the System VM", + "name": "podid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The link local MAC address for the System VM", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "The public IP address for the System VM", + "name": "publicip", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The second DNS for the System VM", + "name": "dns2", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "The gateway for the System VM", + "name": "gateway", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "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", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "The systemvm agent version", + "name": "version", "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 number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "Guest VLAN range", + "name": "guestvlan", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "The public netmask for the System VM", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" } ] }, @@ -110515,12 +110653,11 @@ "type": "integer" }, { - "description": "Storage Pool ID", + "description": "Notify if IOPS above this value", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "iopsnotifythreshold", "required": true, - "type": "uuid" + "type": "integer" }, { "description": "Zone ID", @@ -110531,76 +110668,50 @@ "type": "uuid" }, { - "description": "Notify if IOPS above this value", + "description": "Shares per GB", "length": 255, - "name": "iopsnotifythreshold", + "name": "sharespergb", "required": true, "type": "integer" }, { - "description": "Shares per GB", + "description": "Storage Pool ID", "length": 255, - "name": "sharespergb", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} - ], - "since": "4.11.0" - }, - { - "description": "Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console", - "isasync": false, - "name": "cloudianSsoLogin", - "params": [], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the sso redirect url", - "name": "url", - "type": "string" - }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.11.0" }, { - "description": "Deletes a vmsnapshot.", + "description": "Deletes an Instance Snapshot.", "isasync": true, "name": "deleteVMSnapshot", "params": [ { - "description": "The ID of the VM snapshot", + "description": "The ID of the Instance Snapshot", "length": 255, "name": "vmsnapshotid", "related": "listVMSnapshot,createVMSnapshot", @@ -110609,28 +110720,28 @@ } ], "response": [ - {}, {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -110640,56 +110751,48 @@ "name": "listConsoleSessions", "params": [ { - "description": "The domain ID of the account that created the console endpoint.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the user that created the console endpoint.", + "description": "The ID of the account that created the console endpoint.", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, "type": "uuid" }, { - "description": "IP address of the creator of the console endpoint.", + "description": "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.", "length": 255, - "name": "consoleendpointcreatoraddress", + "name": "acquired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Lists console sessions generated up until this date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The ID of the user that created the console endpoint.", "length": 255, - "name": "enddate", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "List by keyword", + "description": "IP address of the client that accessed the console session.", "length": 255, - "name": "keyword", + "name": "clientaddress", "required": false, "type": "string" }, { - "description": "The ID of the virtual machine.", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "Lists console sessions generated from this date onwards. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { "description": "", @@ -110699,25 +110802,25 @@ "type": "integer" }, { - "description": "The ID of the console session.", + "description": "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", "length": 255, - "name": "id", - "related": "listConsoleSessions", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "Lists console sessions from the specified host.", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The ID of the account that created the console endpoint.", + "description": "The ID of the virtual machine.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, @@ -110729,31 +110832,39 @@ "type": "boolean" }, { - "description": "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.", + "description": "The ID of the console session.", "length": 255, - "name": "acquired", + "name": "id", + "related": "listConsoleSessions", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", + "description": "Lists console sessions generated from this date onwards. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "isrecursive", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "Lists console sessions from the specified host.", + "description": "Lists console sessions generated up until this date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "The domain ID of the account that created the console endpoint.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "IP address of the client that accessed the console session.", + "description": "IP address of the creator of the console endpoint.", "length": 255, - "name": "clientaddress", + "name": "consoleendpointcreatoraddress", "required": false, "type": "string" } @@ -110761,23 +110872,38 @@ "related": "", "response": [ { - "description": "ID of the host.", - "name": "hostid", + "description": "ID of the user that created the console endpoint.", + "name": "userid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Account that created the console endpoint.", + "name": "account", + "type": "string" }, { - "description": "ID of the account that created the console endpoint.", - "name": "accountid", + "description": "Date when the console session was acquired.", + "name": "acquired", + "type": "date" + }, + { + "description": "ID of the console session.", + "name": "id", "type": "string" }, { - "description": "Name of the virtual machine.", - "name": "virtualmachinename", + "description": "Date when the console session was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Domain of the account that created the console endpoint.", + "name": "domain", "type": "string" }, { @@ -110786,29 +110912,31 @@ "type": "string" }, { - "description": "Domain ID of the account that created the console endpoint.", - "name": "domainid", + "description": "Domain path of the account that created the console endpoint.", + "name": "domainpath", "type": "string" }, { - "description": "Name of the host.", - "name": "hostname", + "description": "Name of the virtual machine.", + "name": "virtualmachinename", "type": "string" }, + {}, + {}, { - "description": "IP address of the client that created the console session.", - "name": "clientaddress", + "description": "Domain ID of the account that created the console endpoint.", + "name": "domainid", "type": "string" }, { - "description": "ID of the console session.", - "name": "id", + "description": "ID of the host.", + "name": "hostid", "type": "string" }, { - "description": "Date when the console session was acquired.", - "name": "acquired", - "type": "date" + "description": "IP address of the client that created the console session.", + "name": "clientaddress", + "type": "string" }, { "description": "IP address of the creator of the console endpoint.", @@ -110816,8 +110944,8 @@ "type": "string" }, { - "description": "ID of the user that created the console endpoint.", - "name": "userid", + "description": "Name of the host.", + "name": "hostname", "type": "string" }, { @@ -110826,8 +110954,8 @@ "type": "string" }, { - "description": "Account that created the console endpoint.", - "name": "account", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110836,43 +110964,18 @@ "type": "date" }, { - "description": "Domain of the account that created the console endpoint.", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "Domain path of the account that created the console endpoint.", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the account that created the console endpoint.", + "name": "accountid", "type": "string" - }, - { - "description": "Date when the console session was removed.", - "name": "removed", - "type": "date" } ], "since": "4.21.0" }, { - "description": "Unmanage a guest virtual machine.", + "description": "Unmanage a Guest Instance.", "isasync": true, "name": "unmanageVirtualMachine", "params": [ - { - "description": "Force unmanaging Instance with config drive. Applicable only for KVM Hypervisor.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.22.0", - "type": "boolean" - }, { "description": "ID of the host which will be used for unmanaging the Instance. Applicable only for KVM hypervisor and stopped Instances. Domain XML will be stored on this host.", "length": 255, @@ -110883,43 +110986,51 @@ "type": "uuid" }, { - "description": "The ID of the virtual machine to unmanage", + "description": "The ID of the Instance to unmanage", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" + }, + { + "description": "Force unmanaging Instance with config drive. Applicable only for KVM Hypervisor.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.22.0", + "type": "boolean" } ], "related": "", "response": [ { - "description": "details of the unmanage VM operation", + "description": "Details of the unmanage Instance operation", "name": "details", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "result of the unmanage VM operation", + "description": "Result of the unmanage Instance operation", "name": "success", "type": "boolean" }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The ID of the host used for unmanaged Instance", "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {} + } ], "since": "4.15.0" }, @@ -110928,6 +111039,14 @@ "isasync": true, "name": "rebootRouter", "params": [ + { + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + }, { "description": "Force reboot the router (Router is force Stopped and then Started)", "length": 255, @@ -110935,86 +111054,83 @@ "required": false, "since": "4.16.0", "type": "boolean" - }, - { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" } ], "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "The 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 name of the router", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "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 Pod name for the router", + "name": "podname", + "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 list of nics associated with the router", + "description": "The list of NICs associated with the router", "name": "nic", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { "description": "MTU configured on the NIC", @@ -111022,453 +111138,441 @@ "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The netmask of the NIC", + "name": "netmask", "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 gateway of the nic", + "description": "The gateway of the NIC", "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "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 IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", + "description": "Public IP address ID associated with this NIC via Static NAT rule", "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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 type of the NIC", + "name": "type", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", + "description": "True if NIC is default, false otherwise", "name": "macaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "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 vm to which the nic belongs", + "description": "Id of the Instance 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 NIC", + "name": "id", + "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", + "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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "set" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "The host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "The Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "The second DNS for the router", + "name": "dns2", "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 scripts", - "name": "scriptsversion", + "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 result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the account associated with the router", - "name": "account", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "Role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "The version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "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 state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "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 version of Template", + "name": "version", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "The Template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The ID of the router", + "name": "id", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "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" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The Network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "The name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "The type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" } ] }, { - "description": "list the vm nics IP to NIC", + "description": "List the Instance NICs IP to NIC", "isasync": false, "name": "listNics", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List NIC of the specific Instance's Network", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "The ID of the NIC to list IPs", "length": 255, - "name": "keyword", + "name": "nicid", + "related": "listNics", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the nic to list IPs", + "description": "", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list nic of the specific vm's network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "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 resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, @@ -111476,53 +111580,60 @@ "type": "boolean" }, { - "description": "the ID of the vm", + "description": "The ID of the Instance", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the ip address of the nic", + "description": "The IP address of the NIC", "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the corresponding network", + "description": "The name of the corresponding Network", "name": "networkname", "type": "string" }, @@ -111532,127 +111643,127 @@ "type": "integer" }, { - "description": "the gateway of the nic", + "description": "The gateway of the NIC", "name": "gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "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 Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "the isolated private VLAN type if available", + "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 IPv6 address of network", - "name": "ip6address", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The type of the NIC", + "name": "type", "type": "string" }, - {}, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The ID of the NIC", + "name": "id", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" - } + }, + { + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + }, + {} ] }, { @@ -111661,51 +111772,50 @@ "name": "listCniConfiguration", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the Userdata", + "description": "The ID of the Userdata", "length": 255, "name": "id", "related": "listCniConfiguration", @@ -111713,63 +111823,58 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Userdata name to look for", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "Userdata name to look for", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "path of the domain to which the User Data owner belongs", - "name": "domainpath", + "description": "The owner of the User Data", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the owner of the User Data", - "name": "account", + "description": "The project name of the User Data", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the User Data", + "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 User Data owner", - "name": "domainid", + "description": "The owner id of the User Data", + "name": "accountid", "type": "string" }, - {}, { - "description": "Name of the User Data", - "name": "name", + "description": "The domain name of the User Data owner", + "name": "domain", "type": "string" }, { @@ -111778,33 +111883,39 @@ "type": "string" }, { - "description": "the owner id of the User Data", - "name": "accountid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the User Data", - "name": "project", + "description": "Path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the User Data owner", - "name": "domain", + "description": "The project id of the User Data", + "name": "projectid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", "name": "params", "type": "string" }, { - "description": "base64 encoded User Data content", + "description": "Base64 encoded User Data content", "name": "userdata", "type": "string" }, { - "description": "the project id of the User Data", - "name": "projectid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The domain id of the User Data owner", + "name": "domainid", "type": "string" }, {} @@ -111817,32 +111928,19 @@ "name": "listBgpPeers", "params": [ { - "description": "AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, - { - "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", - "length": 255, - "name": "isdedicated", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "description": "the domain ID which the Bgp Peer is dedicated to.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "UUID of the Bgp Peer.", @@ -111860,45 +111958,78 @@ "type": "integer" }, { - "description": "", + "description": "AS number of the Bgp Peer.", "length": 255, - "name": "pagesize", + "name": "asnumber", "required": false, - "type": "integer" + "type": "long" }, { - "description": "project who which the Bgp Peer is dedicated to", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the domain ID which the Bgp Peer is dedicated to.", + "description": "UUID of zone to which the Bgp Peer belongs to.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "UUID of zone to which the Bgp Peer belongs to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", + "length": 255, + "name": "isdedicated", + "required": false, + "type": "boolean" + }, + { + "description": "project who which the Bgp Peer is dedicated to", + "length": 255, + "name": "projectid", + "related": "", "required": false, "type": "uuid" } ], "related": "releaseBgpPeer", "response": [ + {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "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 bgp peer", "name": "projectid", @@ -111914,64 +112045,44 @@ "name": "password", "type": "string" }, - { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - {}, { "description": "IPv6 address of bgp peer", "name": "ip6address", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, { "description": "the project name of the bgp peer", "name": "project", "type": "string" }, + {}, { "description": "AS number of bgp peer", "name": "asnumber", "type": "long" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" - }, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" - }, - { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -111979,28 +112090,28 @@ "since": "4.20.0" }, { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", + "description": "Creates an instant Snapshot of a volume from existing Instance Snapshot.", "isasync": true, "name": "createSnapshotFromVMSnapshot", "params": [ { - "description": "The ID of the disk volume", + "description": "The ID of the Instance Snapshot", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" }, { - "description": "The ID of the VM snapshot", + "description": "The ID of the disk volume", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, { - "description": "the name of the snapshot", + "description": "The name of the Snapshot", "length": 255, "name": "name", "required": false, @@ -112010,239 +112121,249 @@ "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "type of the disk volume", + "description": "Type of the disk volume", "name": "volumetype", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" - }, - { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", - "type": "long" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, - {}, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "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", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "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 project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "The parent name of the Snapshot", + "name": "parentname", + "type": "string" + }, + { + "description": "The domain name of the Snapshot's Account", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The Account associated with the Snapshot", + "name": "account", + "type": "string" + }, + {}, + { + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The date the Snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "The project id of the Snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "Indicates whether the underlying storage supports reverting the volume to this Snapshot", + "name": "revertable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "The type of the Snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "the 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": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", "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": "download progress of a snapshot", "name": "downloaddetails", "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "Physical size of backed up Snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "Name of the Snapshot", + "name": "name", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "Display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "id of the os on volume", + "description": "ID of the os on volume", "name": "ostypeid", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "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": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "The parent ID of the Snapshot", + "name": "parent", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the Snapshot", + "name": "id", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "Valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The project name of the Snapshot", + "name": "project", "type": "string" }, - {} + { + "description": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", + "type": "long" + } ], "since": "4.10.0" }, @@ -112251,20 +112372,6 @@ "isasync": false, "name": "listImageStoreObjects", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "path to list on image store", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -112286,54 +112393,69 @@ "name": "page", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ + }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, + {}, + {}, { "description": "Name of the data store object.", "name": "name", "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, - {}, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { @@ -112341,20 +112463,19 @@ "name": "isdirectory", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" } ], @@ -112366,14 +112487,29 @@ "name": "dedicateGuestVlanRange", "params": [ { - "description": "account who will own the VLAN", + "description": "Domain ID of the Account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Account who will own the VLAN", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "project who will own the VLAN", + "description": "Guest VLAN range to be dedicated", + "length": 255, + "name": "vlanrange", + "required": true, + "type": "string" + }, + { + "description": "Project who will own the VLAN", "length": 255, "name": "projectid", "related": "", @@ -112381,92 +112517,77 @@ "type": "uuid" }, { - "description": "physical network ID of the vlan", + "description": "Physical Network ID of the VLAN", "length": 255, "name": "physicalnetworkid", "related": "", "required": true, "type": "uuid" - }, - { - "description": "guest vlan range to be dedicated", - "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "The ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "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", + "description": "The domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "The domain ID of the guest VLAN range", + "name": "domainid", "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 domain ID of the guest VLAN range", - "name": "domainid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "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 project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the project name of the guest vlan range", + "description": "The project name of the guest VLAN range", "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "The guest VLAN range", + "name": "guestvlanrange", "type": "string" + }, + { + "description": "The physical Network of the guest VLAN range", + "name": "physicalnetworkid", + "type": "long" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -112476,115 +112597,115 @@ "name": "updateIso", "params": [ { - "description": "the format for the image", - "length": 255, - "name": "format", + "description": "The name of the image file", + "length": 251, + "name": "name", "required": false, "type": "string" }, { - "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", + "description": "The ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "forceupdateostype", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "since": "4.21", - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "True if the Template type is routing i.e., if Template is used to deploy router", "length": 255, - "name": "requireshvm", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "bootable", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "description": "The display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "Sort key of the Template, integer", "length": 255, "name": "sortkey", "required": false, "type": "integer" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "True if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "isdynamicallyscalable", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "sshkeyenabled", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "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" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "True if the image supports the password reset feature; default is false", "length": 255, - "name": "details", + "name": "passwordenabled", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", "length": 255, - "name": "arch", + "name": "forceupdateostype", "required": false, - "since": "4.20", - "type": "string" + "since": "4.21", + "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "passwordenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "the name of the image file", + "description": "The format for the image", "length": 255, - "name": "name", + "name": "format", "required": false, "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "length": 255, - "name": "cleanupdetails", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "True if the Template supports the SSHkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the image file", + "description": "The ID of the image file", "length": 255, "name": "id", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -112595,369 +112716,369 @@ "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "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 ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "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 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 userdata linked to this template", - "name": "userdataname", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "The Template name", + "name": "name", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "The project name of the Template", + "name": "project", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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", + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", + "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": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "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", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "the template ID", - "name": "id", + "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 processor bit size", + "name": "bits", + "type": "int" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The id of userdata linked to this Template", + "name": "userdataid", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "The size of the Template", + "name": "size", + "type": "long" }, { - "description": "the template display text", - "name": "displaytext", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "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": "CPU Arch of the template", - "name": "arch", + "description": "The tag of this Template", + "name": "templatetag", "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": "The name of extension linked to this template", - "name": "extensionname", + "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 extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Checksum of the Template", + "name": "checksum", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "The status of the Template", + "name": "status", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The 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 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": "The date this Template was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "The date this Template was created", + "name": "created", + "type": "date" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, - {}, { - "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "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": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the status of the template", - "name": "status", + "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": "Deletes a counter for VM auto scaling", + "description": "Deletes a counter for Instance auto scaling", "isasync": true, "name": "deleteCounter", "params": [ { - "description": "the ID of the counter", + "description": "The ID of the counter", "length": 255, "name": "id", "related": "createCounter", @@ -112966,27 +113087,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": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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" + }, + {}, {} ] }, @@ -113002,6 +113123,13 @@ "required": false, "type": "string" }, + { + "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + }, { "description": "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, @@ -113016,13 +113144,6 @@ "required": false, "type": "string" }, - { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -113033,15 +113154,15 @@ ], "related": "listCaCertificate", "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 CA certificate(s)", - "name": "cacertificates", + "description": "The client certificate", + "name": "certificate", "type": "string" }, { @@ -113050,14 +113171,14 @@ "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" }, {} ], @@ -113069,267 +113190,267 @@ "name": "createPortForwardingRule", "params": [ { - "description": "the starting port of port forwarding rule's public port range", + "description": "The starting port of port forwarding rule's public port range", "length": 255, "name": "publicport", "required": true, "type": "integer" }, { - "description": "the IP address id of the port forwarding rule", + "description": "The Network of the Instance 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": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "The ending port of port forwarding rule's private port range", "length": 255, - "name": "privateendport", + "name": "publicendport", "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 ID of the virtual machine for the port forwarding rule", + "description": "The IP address ID of the port forwarding rule", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "The protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, - "name": "privateport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "The starting port of port forwarding rule's private port range", "length": 255, - "name": "protocol", + "name": "privateport", "required": true, - "type": "string" + "type": "integer" }, { - "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 source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", "length": 255, - "name": "openfirewall", + "name": "cidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "Instance guest NIC secondary IP address for the port forwarding rule", "length": 255, "name": "vmguestip", "required": false, "type": "string" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "description": "The ID of the Instance for the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "The ending port of port forwarding rule's private port range", "length": 255, - "name": "publicendport", + "name": "privateendport", "required": false, "type": "integer" }, { - "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "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": "cidrlist", + "name": "openfirewall", "required": false, - "type": "list" + "type": "boolean" + }, + { + "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": "updatePortForwardingRule", "response": [ { - "description": "the list of resource tags associated with the rule", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "The public IP address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "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": "tag key name", - "name": "key", + "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The 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 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 Instance IP address for the port forwarding rule", + "name": "vmguestip", + "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": "privateendport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", + "description": "The protocol of the port forwarding rule", "name": "protocol", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "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 Instance name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "Is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "The Instance display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "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": "privateendport", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", "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" }, { - "description": "the ID of the port forwarding rule", + "description": "The ID of the port forwarding rule", "name": "id", "type": "string" } ] }, { - "description": "load template into primary storage", + "description": "Load Template into primary storage", "isasync": false, "name": "prepareTemplate", "params": [ { - "description": "template ID of the template to be prepared in primary storage(s).", + "description": "Storage pool ID of the primary storage pool to which the Template should be prepared. If it is not provided the Template is prepared on all the available primary storage pools.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "uuid" }, { - "description": "zone ID of the template to be prepared in primary storage(s).", + "description": "Zone ID of the Template to be prepared in primary storage(s).", "length": 255, "name": "zoneid", "related": "listZones", @@ -113337,370 +113458,370 @@ "type": "uuid" }, { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "description": "Template ID of the Template to be prepared in primary storage(s).", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the name of the secondary storage host for the template", + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The project ID of the Template", + "name": "projectid", + "type": "string" + }, + { + "description": "The name of the secondary storage host for the Template", "name": "hostname", "type": "string" }, + { + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" + }, + {}, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" + }, + { + "description": "The tag of this Template", + "name": "templatetag", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", "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 ID of extension linked to this template", - "name": "extensionid", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "The processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "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", + "name": "crossZones", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", + "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" } ], "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "checksum of the template", + "description": "Checksum of the Template", "name": "checksum", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "The Template display text", + "name": "displaytext", "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 account name to which the template belongs", - "name": "account", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "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": "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 name of the zone for this template", - "name": "zonename", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "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 template display text", - "name": "displaytext", + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "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": "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 id of userdata linked to this template", + "description": "The id of userdata linked to this Template", "name": "userdataid", "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": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the zone for this template", + "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": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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 ID of the OS type for this Template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the format of the template.", + "description": "The format of the Template.", "name": "format", "type": "imageformat" }, { - "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", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The project name of the Template", + "name": "project", "type": "string" }, - {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "The size of the Template", + "name": "size", + "type": "long" }, { - "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 secondary storage host for the template", - "name": "hostid", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "The date this Template was removed", + "name": "removed", + "type": "date" }, {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The 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 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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, + {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" } ] }, @@ -113710,73 +113831,73 @@ "name": "dedicateZone", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "The ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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 zone", + "description": "The ID of the zone", "length": 255, "name": "zoneid", "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the Name of the Zone", - "name": "zonename", + "description": "The ID of the dedicated resource", + "name": "id", "type": "string" }, + {}, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "The Name of the Zone", + "name": "zonename", "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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the Zone", + "name": "zoneid", + "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", + "description": "The Dedication Affinity Group ID of the zone", "name": "affinitygroupid", "type": "string" - } + }, + {} ] }, { @@ -113784,6 +113905,14 @@ "isasync": false, "name": "updateBackupOffering", "params": [ + { + "description": "The ID of the Backup Offering to be updated", + "length": 255, + "name": "id", + "related": "updateBackupOffering", + "required": true, + "type": "uuid" + }, { "description": "Whether to allow user driven backups or not", "length": 255, @@ -113792,24 +113921,16 @@ "type": "boolean" }, { - "description": "The name of the Backup Offering to be updated", + "description": "The description of the Backup Offering to be updated", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "The ID of the Backup Offering to be updated", - "length": 255, - "name": "id", - "related": "updateBackupOffering", - "required": true, - "type": "uuid" - }, - { - "description": "The description of the Backup Offering to be updated", + "description": "The name of the Backup Offering to be updated", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" } @@ -113817,18 +113938,8 @@ "related": "", "response": [ { - "description": "provider name", - "name": "provider", - "type": "string" - }, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" - }, - { - "description": "zone ID", - "name": "zoneid", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { @@ -113836,48 +113947,58 @@ "name": "crosszoneinstancecreation", "type": "boolean" }, + {}, { - "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", + "type": "string" }, { - "description": "the date this backup offering was created", + "description": "The date this backup offering was created", "name": "created", "type": "date" }, { - "description": "description for the backup offering", - "name": "description", - "type": "string" + "description": "Whether the offering allows User driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, - {}, { - "description": "ID of the backup offering", - "name": "id", + "description": "provider name", + "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name for the backup offering", + "name": "name", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "Description for the backup offering", + "name": "description", "type": "string" }, { - "description": "zone name", + "description": "Zone name", "name": "zonename", "type": "string" }, { - "description": "name for the backup offering", - "name": "name", + "description": "Zone ID", + "name": "zoneid", "type": "string" - } + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.16.0" }, @@ -113887,83 +114008,84 @@ "name": "listBuckets", "params": [ { - "description": "", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "List by keyword", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "keyword", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "string" + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the bucket", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the bucket", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listBuckets", "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the name of the bucket", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the bucket", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "id", - "related": "listBuckets", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -113975,194 +114097,193 @@ "type": "map" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", - "related": "listBuckets", + "name": "isrecursive", "required": false, - "type": "list" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "name of the Bucket", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, { "description": "Object storage provider", "name": "provider", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the project name of the bucket", "name": "project", "type": "string" }, - {}, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "id of the object storage hosting the Bucket; returned to admin user only", "name": "objectstorageid", "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Bucket Quota in GiB", - "name": "quota", - "type": "integer" + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", - "type": "string" + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The 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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the Bucket", - "name": "name", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { "description": "Bucket Object Locking", @@ -114170,20 +114291,20 @@ "type": "boolean" }, { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" } ], "since": "4.19.0" }, { - "description": "Stops an Internal LB vm.", + "description": "Stops an Internal LB Instance.", "isasync": true, "name": "stopInternalLoadBalancerVM", "params": [ { - "description": "the ID of the internal lb vm", + "description": "The ID of the internal LB Instance", "length": 255, "name": "id", "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", @@ -114191,7 +114312,7 @@ "type": "uuid" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.", "length": 255, "name": "forced", "required": false, @@ -114201,442 +114322,335 @@ "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "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 name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check if available", - "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" - }, - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - } - ], - "type": "list" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The host ID for the router", + "name": "hostid", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the router", + "description": "The name of the router", "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the router template requires upgrader", + "description": "True if the router Template requires upgrade", "name": "requiresupgrade", "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "The domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "The state of the router", + "name": "state", + "type": "state" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "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": "Role of the domain router", + "name": "role", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "The result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "The type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "The Network domain for the router", + "name": "networkdomain", "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 date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The version of Template", + "name": "version", "type": "string" }, { - "description": "the ID of the corresponding public network", + "description": "The ID of the corresponding public Network", "name": "publicnetworkid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the account associated with the router", + "description": "The Account associated with the router", "name": "account", "type": "string" }, { - "description": "the domain ID associated with the router", + "description": "The domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "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 gateway for the router", - "name": "gateway", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the Pod name for the router", + "description": "The Pod name for the router", "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - {}, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of redundant virtual router", + "description": "The state of redundant virtual router", "name": "redundantstate", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the 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 link local IP address for the router", + "description": "The Control IP address for the router", "name": "linklocalip", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the list of nics associated with the router", + "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", - "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, - { - "description": "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "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 IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "MTU configured on the NIC", @@ -114644,36 +114658,143 @@ "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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" } ], "type": "set" }, { - "description": "the template name for the router", + "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 name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "The Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "The guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + {}, + { + "description": "The link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "The Template name for the router", "name": "templatename", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The ID of the router", + "name": "id", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", + "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 public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "The guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" } ] @@ -114684,18 +114805,25 @@ "name": "createGpuDevice", "params": [ { - "description": "ID of the host where the GPU device is located", + "description": "ID of the parent GPU device (for virtual GPU devices)", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": true, + "name": "parentgpudeviceid", + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, "type": "uuid" }, { - "description": "ID of the GPU card type", + "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", "length": 255, - "name": "gpucardid", - "related": "", + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "ID of the host where the GPU device is located", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" }, @@ -114706,14 +114834,6 @@ "required": false, "type": "string" }, - { - "description": "ID of the vGPU profile", - "length": 255, - "name": "vgpuprofileid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.", "length": 255, @@ -114722,18 +114842,19 @@ "type": "string" }, { - "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", + "description": "ID of the GPU card type", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "ID of the parent GPU device (for virtual GPU devices)", + "description": "ID of the vGPU profile", "length": 255, - "name": "parentgpudeviceid", - "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", - "required": false, + "name": "vgpuprofileid", + "related": "", + "required": true, "type": "uuid" } ], @@ -114744,25 +114865,31 @@ "name": "state", "type": "state" }, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" + }, + {}, { "description": "the GPU card ID associated with this GPU device", "name": "gpucardid", "type": "string" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the GPU device", - "name": "id", - "type": "string" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, { "description": "the managed state of the GPU device (Enabled/Disabled)", @@ -114770,18 +114897,13 @@ "type": "managedstate" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", - "type": "string" - }, - { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { @@ -114790,8 +114912,8 @@ "type": "devicetype" }, { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { @@ -114800,35 +114922,34 @@ "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" }, { "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "name": "virtualmachineid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" }, - {}, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" } ], @@ -114839,6 +114960,14 @@ "isasync": false, "name": "updateSecurityGroup", "params": [ + { + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "The new name of the security group.", "length": 255, @@ -114853,608 +114982,551 @@ "related": "updateSecurityGroup", "required": true, "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "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": "the account associated with the tag", + "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 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": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "id of the resource", + "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" + } + ], + "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 resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The 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", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", + "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", "type": "string" }, { - "description": "the description of the security group", + "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", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "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", + "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 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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "set" }, { - "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", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", + "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 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" + } + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ + { + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "Assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the security group", + "description": "Domain UUID, required for adding domain from another Region", + "length": 255, "name": "domainid", + "required": false, "type": "string" }, + { + "description": "Creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listDomains,listDomains", + "response": [ {}, { - "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 memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "The total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "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 gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" }, - {}, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "The Network domain", + "name": "networkdomain", "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 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 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 key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" - } - ], - "type": "set" - } - ], - "since": "4.14.0.0" - }, - { - "description": "SP initiated SAML Single Sign On", - "isasync": false, - "name": "samlSso", - "params": [ - { - "description": "Identity Provider Entity ID", - "length": 255, - "name": "idpid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", - "type": "string" - }, - { - "description": "user time zone", - "name": "timezone", - "type": "string" - }, - { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" - }, - { - "description": "Is user registered", - "name": "registered", - "type": "string" - }, - { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" - }, - { - "description": "User ID", - "name": "userid", - "type": "string" - }, - { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", - "type": "string" - }, - { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "The total number of Networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, - {}, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "description": "The total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "Username", - "name": "username", + "description": "The total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "first name of the user", - "name": "firstname", - "type": "string" + "description": "The total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "The total number of VPCs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Creates a domain", - "isasync": false, - "name": "createDomain", - "params": [ - { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, + "description": "The total number of public IP addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "Network domain for networks in the domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "The total number of Templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "Domain UUID, required for adding domain from another Region", - "length": 255, - "name": "domainid", - "required": false, + "description": "The total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", - "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "listDomains,listDomains", - "response": [ - { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "The total number of VPCs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "The ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "The total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "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 date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", - "type": "string" - }, - {}, - { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "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", - "type": "string" + "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", + "description": "The total number of Snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { @@ -115463,94 +115535,69 @@ "type": "list" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "The total number of Instances that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the name of the domain", - "name": "name", + "description": "The total number of Snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", - "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 Templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "The path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "description": "The domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "The total number of Instances deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of cpu cores the domain can own", + "description": "The total number of CPU cores the domain can own", "name": "cpulimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "The total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "Details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the total number of gpus owned by domain", @@ -115558,159 +115605,119 @@ "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "The total number of Templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, - {}, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "The state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "The total number of Instances available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "The level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", + "description": "The total secondary storage space (in GiB) the domain can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "The total number of VPCs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "The total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "The total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "The name of the domain", + "name": "name", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "The total number of public IP addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "The domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "The date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "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 available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The total number of Networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "The total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" } ] @@ -115721,21 +115728,28 @@ "name": "addImageStore", "params": [ { - "description": "the URL for the image store", - "length": 2048, - "name": "url", + "description": "The name for the image store", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "The image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "The details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, "name": "details", "required": false, "type": "map" }, { - "description": "the Zone ID for the image store", + "description": "The Zone ID for the image store", "length": 255, "name": "zoneid", "related": "listZones", @@ -115743,16 +115757,9 @@ "type": "uuid" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, - { - "description": "the name for the image store", - "length": 255, - "name": "name", + "description": "The URL for the image store", + "length": 2048, + "name": "url", "required": false, "type": "string" } @@ -115760,76 +115767,76 @@ "related": "addSecondaryStorage,listSwifts", "response": [ { - "description": "the name of the image store", - "name": "name", + "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 ID of the image store", + "name": "id", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the image store", + "description": "The Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "The URL of the image store", + "name": "url", "type": "string" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "The provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the scope of the image store", + "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "defines if store is read-only", + "description": "Defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "The Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "The name of the image store", + "name": "name", + "type": "string" } ], "since": "4.2.0" @@ -115840,77 +115847,77 @@ "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) hypervisor type", + "description": "(Optional) alias of the SSL certificate", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(Optional) zone to revoke certificate", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "(optional) alias of the SSL certificate", + "description": "ID of the certificate", "length": 255, - "name": "name", + "name": "id", + "related": "listTemplateDirectDownloadCertificates", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(optional) zone to revoke certificate", + "description": "(Optional) the host ID to revoke certificate", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "id of the certificate", + "description": "(Optional) hypervisor type", "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" } ], "related": "provisionTemplateDirectDownloadCertificate", "response": [ + {}, { - "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 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": "Indicates the details in case of failure or host skipped", + "name": "details", "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": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "The name of the host", + "name": "hostname", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "The ID of the host", + "name": "hostid", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.13" @@ -115932,33 +115939,40 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "True if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, + {}, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "The IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -115967,151 +115981,144 @@ "type": "string" }, { - "description": "the pool's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the storage pool", + "description": "The state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "bytes CloudStack can provision from this storage pool", "name": "capacitybytes", "type": "long" }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, { "description": "total IOPS currently in use", "name": "usediops", "type": "long" }, { - "description": "the tags for the storage pool", + "description": "The tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "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 storage pool type", + "name": "type", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "The Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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 storage pool capabilities", + "description": "The storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "The Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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 storage pool details", - "name": "details", - "type": "map" + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "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 ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, - {}, { - "description": "the pool's currently used disk size", - "name": "disksizeused", + "description": "The pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" } ], "since": "4.16.0" @@ -116121,6 +116128,14 @@ "isasync": false, "name": "unregisterExtension", "params": [ + { + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions,updateExtension,unregisterExtension", + "required": true, + "type": "uuid" + }, { "description": "ID of the resource to register the extension with", "length": 255, @@ -116134,49 +116149,39 @@ "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "ID of the extension", - "length": 255, - "name": "extensionid", - "related": "listExtensions,updateExtension,unregisterExtension", - "required": true, - "type": "uuid" } ], "related": "listExtensions,updateExtension", "response": [ { - "description": "ID of the extension", - "name": "id", + "description": "The state of the extension", + "name": "state", "type": "string" }, {}, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "Description of the extension", + "name": "description", "type": "string" }, - {}, { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" + "description": "Type of the extension", + "name": "type", + "type": "string" }, { "description": "Name of the extension", "name": "name", "type": "string" }, - {}, { - "description": "Type of the extension", - "name": "type", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, { - "description": "The state of the extension", - "name": "state", + "description": "ID of the extension", + "name": "id", "type": "string" }, { @@ -116185,42 +116190,23 @@ "type": "date" }, { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" - }, - { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Description of the extension", - "name": "description", - "type": "string" - }, - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ { - "description": "ID of the resource associated with the extension", - "name": "id", + "description": "Type of the resource", + "name": "type", "type": "string" }, { @@ -116229,22 +116215,48 @@ "type": "string" }, { - "description": "the details of the resource map", - "name": "details", - "type": "map" + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" }, { - "description": "Type of the resource", - "name": "type", + "description": "ID of the resource associated with the extension", + "name": "id", "type": "string" }, { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" + "description": "the details of the resource map", + "name": "details", + "type": "map" } ], "type": "list" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.21.0" @@ -116255,18 +116267,18 @@ "name": "listNsxControllers", "params": [ { - "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" }, { "description": "", @@ -116286,68 +116298,68 @@ ], "related": "", "response": [ + {}, { - "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", - "name": "tier0gateway", + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", "type": "string" }, + {}, { - "description": "NSX controller port", - "name": "port", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", "type": "string" }, - {}, { "description": "NSX controller hostname or IP address", "name": "hostname", "type": "string" }, { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "description": "NSX controller port", + "name": "port", "type": "string" }, { - "description": "Zone ID to which the NSX controller is associated with", - "name": "zoneid", + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, - {}, { - "description": "Zone name to which the NSX controller is associated with", - "name": "zonename", + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", + "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "NSX controller name", "name": "name", "type": "string" }, { - "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", - "name": "transportzone", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" } ], "since": "4.19.0" }, { - "description": "Changes ownership of a Volume from one account to another.", + "description": "Changes ownership of a Volume from one Account to another.", "isasync": false, "name": "assignVolume", "params": [ @@ -116363,12 +116375,12 @@ "description": "The ID of the volume to be reassigned.", "length": 255, "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "description": "The ID of the Account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", "length": 255, "name": "accountid", "related": "disableAccount,enableAccount,updateAccount,listAccounts", @@ -116376,432 +116388,432 @@ "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "Size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" + }, + { + "description": "Name of the Instance", + "name": "vmname", + "type": "string" + }, + { + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "id of the virtual machine", + "description": "ID of the Instance", "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "The state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "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": "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": "ID of the disk volume", - "name": "id", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "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": "state of the virtual machine", - "name": "vmstate", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", + "description": "True if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, + { + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" + }, { "description": "path of the Domain the disk volume belongs to", "name": "domainpath", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "The disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "The bytes allocated", + "name": "virtualsize", "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": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", + "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 Instance", "name": "isoname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Min IOPS of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "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": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "Display name of the Instance", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", + "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", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "type of the virtual machine", + "description": "Type of the Instance", "name": "vmtype", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the status of the volume", + "description": "The status of the volume", "name": "status", "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "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 disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "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" - }, - {} + } ], "since": "4.18.0.0" }, @@ -116811,14 +116823,7 @@ "name": "deleteUserData", "params": [ { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "listDomains,listDomains", @@ -116826,7 +116831,7 @@ "type": "uuid" }, { - "description": "the ID of the Userdata", + "description": "The ID of the Userdata", "length": 255, "name": "id", "related": "", @@ -116834,7 +116839,14 @@ "type": "uuid" }, { - "description": "an optional project for the userdata", + "description": "An optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "An optional project for the userdata", "length": 255, "name": "projectid", "related": "", @@ -116843,27 +116855,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": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ], "since": "4.18" @@ -116874,123 +116886,123 @@ "name": "listSupportedNetworkServices", "params": [ { - "description": "network service provider name", + "description": "Network service provider name", "length": 255, "name": "provider", "required": false, "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" }, { - "description": "network service name to list providers and capabilities of", + "description": "Network service name to list providers and capabilities of", "length": 255, "name": "service", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The service name", + "name": "name", + "type": "string" + }, + {}, {}, { - "description": "the service provider name", - "name": "provider", + "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 destination physical network", - "name": "destinationphysicalnetworkid", + "description": "The capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "The capability name", + "name": "name", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "The service provider name", + "name": "provider", + "response": [ + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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": "Services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "uuid of the network provider", + "description": "UUID of the Network provider", "name": "id", "type": "string" }, { - "description": "the provider name", + "description": "The provider name", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "description": "the capability name", - "name": "name", + "description": "State of the Network provider", + "name": "state", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "3.0.0" @@ -117011,26 +117023,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -117040,22 +117052,22 @@ "name": "addNetworkServiceProvider", "params": [ { - "description": "the destination Physical Network ID to bridge to", + "description": "The list of services to be enabled for this physical network service provider", "length": 255, - "name": "destinationphysicalnetworkid", - "related": "", + "name": "servicelist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the list of services to be enabled for this physical network service provider", + "description": "The destination Physical Network ID to bridge to", "length": 255, - "name": "servicelist", + "name": "destinationphysicalnetworkid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the Physical Network ID to add the provider to", + "description": "The Physical Network ID to add the provider to", "length": 255, "name": "physicalnetworkid", "related": "", @@ -117063,7 +117075,7 @@ "type": "uuid" }, { - "description": "the name for the physical network service provider", + "description": "The name for the physical network service provider", "length": 255, "name": "name", "required": true, @@ -117072,63 +117084,63 @@ ], "related": "listTrafficTypes", "response": [ + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, {}, { - "description": "the provider name", + "description": "The provider name", "name": "name", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "State of the Network provider", + "name": "state", "type": "string" }, { - "description": "uuid of the network provider", + "description": "UUID of the Network provider", "name": "id", "type": "string" }, {}, { - "description": "the physical network this belongs to", + "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", + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" }, { - "description": "Delete site to site vpn gateway", + "description": "Delete site to site VPN gateway", "isasync": true, "name": "deleteVpnGateway", "params": [ { - "description": "id of customer gateway", + "description": "ID of customer gateway", "length": 255, "name": "id", "related": "updateVpnGateway", @@ -117137,28 +117149,28 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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", + "description": "True 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" + }, + {} ] }, { @@ -117176,25 +117188,25 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" } @@ -117207,284 +117219,251 @@ "name": "createServiceOffering", "params": [ { - "description": "io requests read rate of the disk offering", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "iopsreadrate", + "name": "byteswriteratemaxlength", "required": false, "type": "long" }, { - "description": "The display text of the service offering, defaults to 'name'.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, - { - "description": "Lease expiry action, valid values are STOP and DESTROY", - "length": 255, - "name": "leaseexpiryaction", - "required": false, - "since": "4.21.0", - "type": "string" - }, - { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "The CPU number of the service offering", "length": 255, - "name": "networkrate", + "name": "cpunumber", "required": false, "type": "integer" }, { - "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": "the ID of the disk offering to which service offering should be mapped", + "description": "Details for planner, used to store specific parameters", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "serviceofferingdetails", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" }, { - "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": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "isvolatile", + "name": "leaseexpiryaction", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "Is this a system vm offering", "length": 255, - "name": "maxmemory", + "name": "issystem", "required": false, - "since": "4.13", - "type": "integer" + "type": "boolean" }, { - "description": "the tags for this service offering.", + "description": "The host tag for this service offering.", "length": 255, - "name": "tags", + "name": "hosttags", "required": false, "type": "string" }, { - "description": "whether compute offering iops is custom or not", + "description": "I/O requests write rate of the disk offering", "length": 255, - "name": "customizediops", + "name": "iopswriterate", "required": false, - "since": "4.4", - "type": "boolean" + "type": "long" }, { - "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", + "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", "length": 255, - "name": "gpucount", + "name": "gpudisplay", "required": false, "since": "4.21", - "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", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "The Root disk size in GB.", "length": 255, - "name": "iopswriteratemaxlength", + "name": "rootdisksize", "required": false, + "since": "4.15", "type": "long" }, { - "description": "Whether service offering size is custom or not", + "description": "The ID of the containing domain(s), null for public offerings", "length": 255, - "name": "customized", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "since": "4.13", - "type": "boolean" + "type": "list" }, { - "description": "bytes read rate of the disk offering", + "description": "Max iops of the compute offering", "length": 255, - "name": "bytesreadrate", + "name": "maxiops", "required": false, + "since": "4.4", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", "length": 255, - "name": "bytesreadratemaxlength", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "Restrict the CPU usage to committed service offering", "length": 255, "name": "limitcpuuse", "required": false, "type": "boolean" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "The deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is used", "length": 255, "name": "deploymentplanner", "required": false, "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "storagetype", + "name": "iopsreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "Bytes write rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "byteswriterate", "required": false, "type": "long" }, { - "description": "the total memory of the service offering in MB", + "description": "The total memory of the service offering in MB", "length": 255, "name": "memory", "required": false, "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "byteswriteratemax", + "name": "maxcpunumber", "required": false, - "type": "long" + "since": "4.13", + "type": "integer" }, { - "description": "Number of days instance is leased for.", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "leaseduration", + "name": "bytesreadratemaxlength", "required": false, - "since": "4.21.0", - "type": "integer" + "type": "long" }, { - "description": "details for planner, used to store specific parameters", + "description": "Data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "serviceofferingdetails", + "name": "networkrate", "required": false, - "type": "map" + "type": "integer" }, { - "description": "max iops of the compute offering", + "description": "The HA for the service offering", "length": 255, - "name": "maxiops", + "name": "offerha", "required": false, - "since": "4.4", - "type": "long" + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "byteswriterate", + "name": "externaldetails", "required": false, - "type": "long" + "since": "4.21.0", + "type": "map" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "maxcpunumber", + "name": "minmemory", "required": false, "since": "4.13", "type": "integer" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "purgeresources", "required": false, - "since": "4.4", - "type": "integer" + "since": "4.20", + "type": "boolean" }, { - "description": "the HA for the service offering", + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the Instance will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", "length": 255, - "name": "offerha", + "name": "cpuspeed", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", + "description": "The ID of the containing zone(s), null for public offerings", "length": 255, - "name": "cachemode", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.14", - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "the ID of the vGPU profile to which service offering should be mapped", "length": 255, - "name": "storagepolicy", + "name": "vgpuprofileid", "related": "", "required": false, - "since": "4.15", + "since": "4.21", "type": "uuid" }, { - "description": "the Root disk size in GB.", + "description": "The name of the service offering", "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.15", - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { - "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "description": "The system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "cpuspeed", + "name": "systemvmtype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "min iops of the compute offering", + "description": "Burst requests read rate of the disk offering", "length": 255, - "name": "miniops", + "name": "iopsreadratemax", "required": false, - "since": "4.4", "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "The tags for this service offering.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "tags", "required": false, - "since": "4.13", - "type": "list" + "type": "string" }, { - "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "purgeresources", + "name": "mincpunumber", "required": false, - "since": "4.20", - "type": "boolean" + "since": "4.13", + "type": "integer" }, { "description": "VMs using this offering require root volume encryption", @@ -117495,443 +117474,466 @@ "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "The storage type of the service offering. Values are local and shared.", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "storagetype", "required": false, - "type": "list" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "iopswriteratemax", + "name": "provisioningtype", + "required": false, + "type": "string" + }, + { + "description": "The display text of the service offering, defaults to 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "Burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "the ID of the vGPU profile to which service offering should be mapped", + "description": "Length (in seconds) of the burst", "length": 255, - "name": "vgpuprofileid", - "related": "", + "name": "iopswriteratemaxlength", "required": false, - "since": "4.21", - "type": "uuid" + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "dynamicscalingenabled", + "name": "customized", "required": false, - "since": "4.16", + "since": "4.13", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", + "description": "The ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "bytesreadratemax", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "since": "4.17", + "type": "uuid" }, { - "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", + "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", "length": 255, - "name": "gpudisplay", + "name": "gpucount", "required": false, "since": "4.21", - "type": "boolean" + "type": "integer" }, { - "description": "the host tag for this service offering.", + "description": "Number of days instance is leased for.", "length": 255, - "name": "hosttags", + "name": "leaseduration", "required": false, - "type": "string" + "since": "4.21.0", + "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "True if Instance needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "byteswriteratemaxlength", + "name": "dynamicscalingenabled", "required": false, - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "Burst io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "externaldetails", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.21.0", - "type": "map" + "since": "4.4", + "type": "integer" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "minmemory", + "name": "storagepolicy", + "related": "", "required": false, - "since": "4.13", - "type": "integer" + "since": "4.15", + "type": "uuid" }, { - "description": "the CPU number of the service offering", + "description": "Min iops of the compute offering", "length": 255, - "name": "cpunumber", + "name": "miniops", "required": false, - "type": "integer" + "since": "4.4", + "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", "length": 255, - "name": "iopsreadratemax", + "name": "diskofferingstrictness", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "Bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "is this a system vm offering", + "description": "True if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instance", "length": 255, - "name": "issystem", + "name": "isvolatile", "required": false, "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "Whether compute offering iops is custom or not", "length": 255, - "name": "provisioningtype", + "name": "customizediops", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the service offering", + "description": "Burst bytes write rate of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "I/O requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "An alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "state of the service offering", - "name": "state", + "description": "The host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "Additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "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": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "True if disk offering uses custom IOPS, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The tags for the service offering", + "name": "storagetags", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "True if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk", + "name": "isvolatile", "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "Bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "The date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", - "type": "integer" + "description": "Deployment strategy used to deploy Instance.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "Burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, + {}, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "The name of the service offering", + "name": "name", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "Burst bytes read rate of the disk offering", "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "Length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "Is this a System VM offering", + "name": "issystem", "type": "boolean" }, - {}, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "Is this a the System VM type for System VM offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "True if Instance needs to be dynamically scalable of CPU or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "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": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the id of the service offering", + "description": "The ID of the service offering", "name": "id", "type": "string" }, { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "Length (in seconds) of the burst", "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the name of the service 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": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "Bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "State of the service offering", + "name": "state", "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "I/O requests read rate of the service offering", + "name": "diskIopsReadRate", "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": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the maximum number of display heads", + "name": "maxheads", "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": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "Data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", - "name": "cacheMode", - "type": "string" + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "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 Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "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": "I/O requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "Instance lease duration (in days) for service offering", - "name": "leaseduration", - "type": "integer" + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "The number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "Is this a default System VM offering", + "name": "defaultuse", "type": "boolean" }, - {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "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 storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "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", + "description": "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "Burst I/O requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "the ID of the vgpu profile to which service offering is linked", @@ -117939,387 +117941,349 @@ "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "Is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "True if Instance root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the memory in MB", + "description": "The memory in MB", "name": "memory", "type": "integer" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" } ] }, { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "description": "Change ownership of an Instance from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign an Instance from any account to any other account in any domain. A domain administrator can reassign an Instance to any account in the same domain.", "isasync": false, "name": "assignVirtualMachine", "params": [ { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "description": "Domain id of the new Instance owner.", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "account name of the new VM owner.", + "description": "Account name of the new Instance owner.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "an optional project for the new VM owner.", + "description": "List of new network IDs in which the moved Instance will participate. In case no network ids are provided the Instance 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": "projectid", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "id of the VM to be moved", + "description": "List of security group ids to be applied on the Instance. In case no security groups are provided the Instance is part of the default security group.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "description": "An optional project for the new Instance owner.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "ID of the Instance to be moved", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, + {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "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 name of the host for the Instance", + "name": "hostname", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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": "ssh key-pairs", - "name": "keypairs", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "description": "True if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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": "the name of the backup offering of the virtual machine", + "description": "The name of the backup offering of the Instance", "name": "backupofferingname", "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { "description": "State of the Service from LB rule", @@ -118327,844 +118291,897 @@ "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the 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": "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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 CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the Instance 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", + "description": "Name of the VPC to which the NIC belongs", "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 ID of the nic", - "name": "id", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "The Account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "The domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "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": "Tag value", + "name": "value", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The 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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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": "tag key name", - "name": "key", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { - "description": "the ending IP of the security group rule ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", + "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 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 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" + } + ], + "type": "set" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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" }, { - "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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "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", + "description": "Account owning the security group rule", "name": "account", "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The Account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the project name of the group", + "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" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The description of the affinity group", + "name": "description", "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 ID of the affinity group", - "name": "id", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "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" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "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": "the name of the affinity group", - "name": "name", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", + "description": "The type of the affinity group", "name": "type", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The project name of the Instance", + "name": "project", + "type": "string" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" } ], "since": "3.0.0" @@ -119174,21 +119191,6 @@ "isasync": false, "name": "listVmsForImport", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "the host name or IP address", "length": 255, @@ -119204,16 +119206,24 @@ "type": "integer" }, { - "description": "the password for the host", + "description": "", "length": 255, - "name": "password", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", "required": false, "type": "string" }, @@ -119224,6 +119234,13 @@ "required": true, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the username for the host", "length": 255, @@ -119235,195 +119252,199 @@ "related": "listVmwareDcVms,listUnmanagedInstances", "response": [ { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "indicates the boot type", - "name": "boottype", - "type": "string" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The CPU speed of the Instance", + "name": "cpuspeed", "type": "integer" }, { - "description": "the list of disks associated with the virtual machine", + "description": "The list of disks associated with the Instance", "name": "disk", "response": [ { - "description": "the label of the disk", - "name": "label", - "type": "string" + "description": "The capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the controller of the disk", + "description": "The controller of the disk", "name": "datastoretype", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", + "description": "The controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "The file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "The controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "The controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "The controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the controller unit of the disk", + "description": "The controller unit of the disk", "name": "controllerunit", "type": "integer" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "The ID of the disk", + "name": "id", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "The label of the disk", + "name": "label", "type": "string" + }, + { + "description": "The position of the disk", + "name": "position", + "type": "integer" } ], "type": "set" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The hypervisor to which Instance belongs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", + "description": "The CPU cores per socket for the Instance. VMware specific", "name": "cpucorepersocket", "type": "integer" }, + { + "description": "The memory of the Instance in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, { "description": "the name of the cluster to which virtual machine belongs", "name": "clustername", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The name of the host to which Instance belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "The list of NICs associated with the Instance", "name": "nic", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 netmask of the NIC", + "name": "netmask", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "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 type of the nic", - "name": "type", + "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 CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { @@ -119432,138 +119453,137 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", + "description": "Id of the Instance to which the NIC belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "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", + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" } ], "type": "set" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "The operating system ID of the Instance", + "name": "osid", + "type": "string" }, + {}, { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "The hypervisor version of the host to which Instance belongs", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "The ID of the cluster to which Instance belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "The power state of the Instance", + "name": "powerstate", "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", + "description": "The ID of the host to which Instance belongs", "name": "hostid", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "The operating system of the Instance", + "name": "osdisplayname", "type": "string" }, + { + "description": "The CPU cores of the Instance", + "name": "cpunumber", + "type": "integer" + }, {} ], "since": "4.19.0" }, { - "description": "configures a netscaler load balancer device", + "description": "Configures a netscaler load balancer device", "isasync": true, "name": "configureNetscalerLoadBalancer", "params": [ { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "True if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, "name": "lbdevicededicated", "required": false, "type": "boolean" }, { - "description": "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", + "description": "Capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, "name": "lbdevicecapacity", "required": false, @@ -119578,9 +119598,16 @@ "type": "list" }, { - "description": "Netscaler load balancer device ID", + "description": "True if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", "length": 255, - "name": "lbdeviceid", + "name": "inline", + "required": false, + "type": "boolean" + }, + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, "type": "uuid" @@ -119589,108 +119616,108 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "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": "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": "device name", - "name": "lbdevicename", + "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", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "Device ID of the netscaler load balancer", + "name": "lbdeviceid", "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": "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 management IP address of the external load balancer", - "name": "ipaddress", - "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 capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "Device name", + "name": "lbdevicename", "type": "string" }, { - "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "Private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "Device state", + "name": "lbdevicestate", + "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": "delete Tungsten-Fabric service group", + "description": "Delete Tungsten-Fabric service group", "isasync": true, "name": "deleteTungstenFabricServiceGroup", "params": [ { - "description": "the uuid of Tungsten-Fabric service group", + "description": "The uuid of Tungsten-Fabric service group", "length": 255, "name": "servicegroupuuid", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -119700,26 +119727,26 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "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", + "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" - }, + {}, {} ] }, @@ -119728,6 +119755,20 @@ "isasync": false, "name": "addObjectStoragePool", "params": [ + { + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", "length": 255, @@ -119737,10 +119778,10 @@ "type": "long" }, { - "description": "the name for the object store", + "description": "the tags for the storage pool", "length": 255, - "name": "name", - "required": true, + "name": "tags", + "required": false, "type": "string" }, { @@ -119751,45 +119792,35 @@ "type": "string" }, { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the tags for the storage pool", + "description": "the name for the object store", "length": 255, - "name": "tags", - "required": false, + "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 name of the object store", "name": "name", "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the url of the object store", @@ -119797,45 +119828,41 @@ "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", "type": "long" }, + {}, { "description": "the allocated size of the object store", "name": "storageallocated", "type": "long" }, { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ], "since": "4.19.0" }, { - "description": "Deletes user from the project", + "description": "Deletes User from the project", "isasync": true, "name": "deleteUserFromProject", "params": [ { - "description": "ID of the project to remove the user from", + "description": "ID of the project to remove the User from", "length": 255, "name": "projectid", "related": "", @@ -119843,7 +119870,7 @@ "type": "uuid" }, { - "description": "Id of the user to be removed from the project", + "description": "Id of the User to be removed from the project", "length": 255, "name": "userid", "related": "disableUser,getUser,listUsers,lockUser", @@ -119852,27 +119879,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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.15.0" @@ -119883,7 +119910,7 @@ "name": "deleteNetworkServiceProvider", "params": [ { - "description": "the ID of the network service provider", + "description": "The ID of the network service provider", "length": 255, "name": "id", "related": "listTrafficTypes", @@ -119892,28 +119919,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -119923,25 +119950,25 @@ "name": "listNetworkDevice", "params": [ { - "description": "", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "pagesize", + "name": "networkdevicetype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "parameters for network device", + "description": "List by keyword", "length": 255, - "name": "networkdeviceparameterlist", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -119951,31 +119978,31 @@ "type": "integer" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "Parameters for network device", "length": 255, - "name": "networkdevicetype", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" } ], "related": "addNetworkDevice", "response": [ + {}, { - "description": "the ID of the network device", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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" } ] }, @@ -119992,13 +120019,6 @@ "required": true, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "List project role by project role ID.", "length": 255, @@ -120008,9 +120028,9 @@ "type": "uuid" }, { - "description": "List project role by project role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -120027,47 +120047,54 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List project role by project role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "updateProjectRole", "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 id of the project", - "name": "projectid", + "description": "The ID of the role", + "name": "id", "type": "string" }, { - "description": "the name of the role", + "description": "The name of the role", "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "The description of the role", + "name": "description", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, - {} + {}, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.15.0" }, @@ -120088,121 +120115,113 @@ "related": "", "response": [ { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The URL of the controller API", + "name": "url", "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 url of the controller api", - "name": "url", + "description": "The name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The physical Network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" }, {}, { - "description": "device id of the controller", + "description": "Device ID of the controller", "name": "id", "type": "string" - }, - {} + } ] }, { - "description": "Updates attributes of a template.", + "description": "Updates attributes of a Template.", "isasync": false, "name": "updateTemplate", "params": [ { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "The ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "arch", + "name": "templatetype", "required": false, - "since": "4.20", "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "length": 255, - "name": "bootable", + "name": "isdynamicallyscalable", "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", + "description": "The name of the image file", + "length": 251, + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "True if the Template supports the SSHkey upload feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "True if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "bootable", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "templatetag", + "name": "arch", "required": false, - "since": "4.20.0", + "since": "4.20", "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "True if the Template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "templatetype", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "requireshvm", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { @@ -120213,16 +120232,9 @@ "type": "map" }, { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "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" }, @@ -120235,398 +120247,413 @@ "type": "boolean" }, { - "description": "indicates that the template can be used for deployment of CKS clusters", - "length": 255, - "name": "forcks", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "the format for the image", + "description": "The format for the image", "length": 255, "name": "format", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "True if the image supports the password reset feature; default is false", "length": 255, - "name": "sshkeyenabled", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the tag for this template.", "length": 255, - "name": "passwordenabled", + "name": "templatetag", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "Sort key of the Template, integer", "length": 255, "name": "sortkey", "required": false, "type": "integer" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" }, - {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "True if the Template type is routing i.e., if Template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the image file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "The display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" - }, + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the account id to which the template belongs", + "description": "The Account id to which the Template belongs", "name": "accountid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", + "description": "True if Template is sshkey enabled, false otherwise", "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "Lists the download progress of a template across all secondary storages", + "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": "the project id of the template", - "name": "projectid", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "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": "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", + "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": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "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": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "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": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, + {}, + { + "description": "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", + "description": "The physical size of the Template", "name": "physicalsize", "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", + "type": "string" }, + {}, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "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": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "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 reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "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": "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 ID of the zone for this template", - "name": "zoneid", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", + "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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The date this Template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "The status of the Template", + "name": "status", + "type": "string" + }, + { + "description": "The date this Template was created", + "name": "created", + "type": "date" + }, + { + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "The tag of this Template", + "name": "templatetag", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Template display text", + "name": "displaytext", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "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 size of the Template", + "name": "size", + "type": "long" }, { - "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": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The type of the Template", + "name": "templatetype", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "The project ID of the Template", + "name": "projectid", + "type": "string" + }, + { + "description": "The URL which the Template/ISO is registered from", + "name": "url", + "type": "string" }, + {}, { - "description": "checksum of the template", + "description": "Checksum of the Template", "name": "checksum", "type": "string" + }, + { + "description": "The id of userdata linked to this Template", + "name": "userdataid", + "type": "string" } ] }, @@ -120636,307 +120663,299 @@ "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", + "description": "The netmask of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "netmask", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "The gateway of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "True if IP range is set to System VMs, false if not", "length": 255, - "name": "account", + "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" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "Provider name for which the IP range is reserved for", "length": 255, - "name": "forsystemvms", + "name": "provider", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "Provider name for which the IP range is reserved for", + "description": "The ending IPv6 address in the IPv6 network range", "length": 255, - "name": "provider", + "name": "endipv6", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "Account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "The CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "startip", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the network id", + "description": "Optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "The physical network ID", "length": 255, - "name": "endipv6", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "True if VLAN is of Virtual type, false if Direct", "length": 255, "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "The beginning IP address in the VLAN IP range", "length": 255, - "name": "endip", + "name": "startip", "required": false, "type": "string" }, { - "description": "the gateway of the IPv6 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": "ip6gateway", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the physical network id", + "description": "Domain ID of the Account owning a VLAN", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "The ending IP address in the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "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": "ip6cidr", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "Project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "startipv6", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "The Network ID", "length": 255, - "name": "projectid", - "related": "", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "the gateway of the VLAN IP range", + "description": "The Zone ID of the VLAN IP range", "length": 255, - "name": "gateway", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateVlanIpRange", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The Network ID of VLAN range", + "name": "networkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The virtual Network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The start IPv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, - {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "Path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "The end IPv6 of the VLAN IP range", + "name": "endipv6", "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 physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the Pod name for the VLAN IP range", + "description": "The Pod name for the VLAN IP range", "name": "podname", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "The project ID of the VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "The ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the VLAN IP range", + "description": "The domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "The description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "The ID of the VLAN IP range", + "name": "id", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "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 gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "The Account of the VLAN IP range", + "name": "account", + "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "The Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vlan range", + "description": "The project name of the VLAN range", "name": "project", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "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 gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, - {}, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "The CIDR of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "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": "indicates to which provider the IP range is dedicated to", + "name": "provider", + "type": "string" } ] }, { - "description": "Updates site to site vpn connection", + "description": "Updates site to site VPN connection", "isasync": true, "name": "updateVpnConnection", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "id of vpn connection", + "description": "ID of VPN connection", "length": 255, "name": "id", "related": "updateVpnConnection", @@ -120944,7 +120963,15 @@ "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": "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, @@ -120955,27 +120982,7 @@ "related": "", "response": [ { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the connection ID", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -120985,131 +120992,152 @@ "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "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.", - "name": "splitconnections", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the project id", + "description": "The project id", "name": "projectid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "The domain id of the owner", + "name": "domainid", "type": "string" }, + { + "description": "The date and time the host was created", + "name": "created", + "type": "date" + }, {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "If Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "Public IP address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "State of VPN connection", + "name": "state", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "The connection ID", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "If DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "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": "the domain id of the owner", - "name": "domainid", + "description": "The customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "The owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "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": "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": "public ip address id of the customer gateway", - "name": "gateway", + "description": "The VPN gateway ID", + "name": "s2svpngatewayid", "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 domain name of the owner", - "name": "domain", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" + }, + { + "description": "State of VPN connection", + "name": "passive", + "type": "boolean" } ], "since": "4.4" }, { - "description": "lists network that are using Palo Alto firewall device", + "description": "Lists Network that are using Palo Alto firewall device", "isasync": false, "name": "listPaloAltoFirewallNetworks", "params": [ { - "description": "List by keyword", + "description": "Palo alto balancer device ID", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "lbdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" }, { "description": "", @@ -121126,83 +121154,136 @@ "type": "integer" }, { - "description": "palo alto balancer device ID", + "description": "List by keyword", "length": 255, - "name": "lbdeviceid", - "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "State of the Network", + "name": "state", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The Network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "The type of the Network", + "name": "type", + "type": "string" + }, + { + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "The internet protocol of Network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "The displaytext of the Network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The Network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The list of resource tags associated with Network", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "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 ID of the domain associated with the tag", + "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": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } @@ -121210,206 +121291,137 @@ "type": "list" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "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 Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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": "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": "ACL type - access type to the Network", + "name": "acltype", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "The second IPv4 DNS for the Network", + "name": "dns2", + "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "ACL name associated with the VPC Network", + "name": "aclname", "type": "string" }, { - "description": "The external id of the network", + "description": "The external ID of the Network", "name": "externalid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "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": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "The first IPv4 DNS for the Network", + "name": "dns1", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "True if Network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" - }, - { - "description": "the list of services", + "description": "The list of services", "name": "service", "response": [ { - "description": "the list of capabilities", + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "the capability name", + "description": "The capability name", "name": "name", "type": "string" }, { - "description": "the capability value", + "description": "The capability value", "name": "value", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", + "description": "Can this service capability value can be choosable while creatine Network offerings", "name": "canchooseservicecapability", "type": "boolean" } @@ -121417,248 +121429,263 @@ "type": "list" }, { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", + "description": "The service provider name", "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", + "description": "True if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the provider name", + "description": "The provider name", "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "state of the network provider", + "description": "Services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "UUID of the Network provider", + "name": "id", + "type": "string" } ], "type": "list" + }, + { + "description": "The service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the owner of the network", - "name": "account", + "description": "Network offering ID the Network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "Related to what other Network configuration", + "name": "related", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "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": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The ID of the Network", + "name": "id", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The domain ID of the Network owner", + "name": "domainid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "The details of the Network", + "name": "details", + "type": "map" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "The date this Network was created", + "name": "created", + "type": "date" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "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", + "name": "ip4routes", "type": "set" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "VPC the Network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "The name of the zone the Network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "An optional field, whether to the display the Network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "List Networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "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 project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" } ] @@ -121678,21 +121705,21 @@ ], "related": "", "response": [ + {}, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "The path field for the volume", - "name": "path", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -121703,14 +121730,7 @@ "name": "listManagementServers", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the id of the management server", + "description": "The ID of the management server", "length": 255, "name": "id", "related": "listManagementServers", @@ -121718,12 +121738,19 @@ "type": "uuid" }, { - "description": "the name of the management server", + "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": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, @@ -121740,179 +121767,187 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the version of the management server", + "length": 255, + "name": "version", "required": false, + "since": "4.20.3", "type": "string" } ], "related": "", "response": [ { - "description": "the name of the OS distribution running on the management server", + "description": "The version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "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", + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" + }, + { + "description": "the IP Address for this Management Server", + "name": "ipaddress", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the number of host agents this Management Server is responsible for", "name": "agentscount", "type": "long" }, - {}, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "The ID of the management server", + "name": "id", + "type": "string" }, { - "description": "the last time this Management Server was started", + "description": "The last time this Management Server was started", "name": "lastserverstart", "type": "date" }, + {}, { - "description": "the Management Server Peers", - "name": "peers", - "type": "list" - }, - { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", + "description": "The last time the host on which this Management Server runs was booted", + "name": "lastboottime", "type": "date" }, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" - }, - { - "description": "the version of the management server", - "name": "version", - "type": "string" - }, - { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the agents this Management Server is responsible for", - "name": "agents", - "type": "list" - }, { "description": "the number of pending jobs in this Management Server", "name": "pendingjobscount", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, { - "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 name of the management server", - "name": "name", + "description": "The version of the management server", + "name": "version", "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "ipaddress", + "description": "The IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "The state of the management server", + "name": "state", + "type": "state" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The name of the management server", + "name": "name", "type": "string" }, { - "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", - "name": "lastagents", - "type": "list" + "description": "The java distribution name running the management server process", + "name": "javadistribution", + "type": "string" } ] }, { - "description": "list Tungsten-Fabric policy", + "description": "List Tungsten-Fabric policy", "isasync": false, "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "The uuid of Tungsten-Fabric rule", "length": 255, - "name": "policyuuid", - "required": true, + "name": "ruleuuid", + "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "The uuid of Tungsten-Fabric policy", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "The ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "", "length": 255, - "name": "ruleuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "addTungstenFabricPolicyRule", "response": [ { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { "description": "Tungsten-Fabric policy source start port", @@ -121920,66 +121955,66 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", "type": "int" }, {}, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { "description": "Tungsten-Fabric policy destination network", @@ -121987,29 +122022,29 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" } ] }, { - "description": "delete Tungsten-Fabric policy", + "description": "Delete Tungsten-Fabric policy", "isasync": true, "name": "deleteTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -122017,7 +122052,7 @@ "type": "uuid" }, { - "description": "the Uuid of Tungsten-Fabric tag type", + "description": "The Uuid of Tungsten-Fabric tag type", "length": 255, "name": "policyuuid", "required": true, @@ -122026,36 +122061,36 @@ ], "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates a vm group", + "description": "Updates an Instance group", "isasync": false, "name": "updateInstanceGroup", "params": [ { - "description": "new instance group name", + "description": "New Instance group name", "length": 255, "name": "name", "required": false, @@ -122073,89 +122108,74 @@ "related": "", "response": [ { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the instance group", - "name": "name", + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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 domain ID of the instance group", - "name": "domainid", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "time and date the instance group was created", + "description": "Time and date the Instance group was created", "name": "created", "type": "date" }, { - "description": "the project ID of the instance group", + "description": "The project ID of the Instance group", "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the instance group", - "name": "id", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the instance group", - "name": "domain", + "description": "The project name of the Instance group", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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 of the instance group", - "name": "project", + "description": "The ID of the Instance group", + "name": "id", "type": "string" }, - {} + { + "description": "The domain ID of the Instance group", + "name": "domainid", + "type": "string" + } ] }, { - "description": "List the uploaded certificates for direct download templates", + "description": "List the uploaded certificates for direct download Templates", "isasync": false, "name": "listTemplateDirectDownloadCertificates", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list direct download certificate by ID", - "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -122166,12 +122186,12 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the zone where certificates are uploaded", + "description": "The zone where certificates are uploaded", "length": 255, "name": "zoneid", "related": "listZones", @@ -122179,82 +122199,97 @@ "type": "uuid" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "If set to true: include the hosts where the certificate is uploaded to", "length": 255, "name": "listhosts", "required": false, "type": "boolean" + }, + { + "description": "List direct download certificate by ID", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ + { + "description": "The direct download certificate alias", + "name": "alias", + "type": "string" + }, {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", + "description": "The hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "The hypervisor of the hosts where the certificate is uploaded", "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the direct download certificate subject", + "description": "The direct download certificate subject", "name": "subject", "type": "string" }, { - "description": "the direct download certificate alias", - "name": "alias", - "type": "string" - }, - { - "description": "the direct download certificate version", - "name": "version", + "description": "The zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "The zone ID where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate issuer", + "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": "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 zone name where the certificate is uploaded", - "name": "zonename", + "description": "The direct download certificate issuer", + "name": "validity", "type": "string" }, + {}, { - "description": "the direct download certificate id", + "description": "The direct download certificate ID", "name": "id", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "The direct download certificate version", + "name": "version", "type": "string" - }, - {} + } ], "since": "4.17.0" }, @@ -122271,21 +122306,22 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "The zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the ucs manager", + "description": "The ID of the ucs manager", "length": 255, "name": "id", "related": "listUcsManagers", @@ -122293,46 +122329,45 @@ "type": "uuid" }, { - "description": "the zone id", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the url of ucs manager", + "description": "The URL of UCS manager", "name": "url", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of ucs manager", + "description": "The name of UCS manager", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The zone ID of UCS manager", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "The ID of the UCS manager", + "name": "id", "type": "string" } ] @@ -122343,18 +122378,18 @@ "name": "changeServiceForRouter", "params": [ { - "description": "the service offering ID to apply to the domain router", + "description": "The ID of the router", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "required": true, "type": "uuid" }, { - "description": "The ID of the router", + "description": "The service offering ID to apply to the domain router", "length": 255, - "name": "id", - "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" } @@ -122362,308 +122397,361 @@ "related": "listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the hostname for the router", - "name": "hostname", + "description": "The guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, + {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "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 account associated with the router", - "name": "account", + "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 Zone name for the router", - "name": "zonename", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "The project name of the address", + "name": "project", "type": "string" }, - {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "The Template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "The state of the router", + "name": "state", + "type": "state" + }, + { + "description": "The ID of the router", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "The version of scripts", + "name": "scriptsversion", "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 link local IP address for the router", - "name": "linklocalip", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", + "description": "The ID of the service offering of the Instance", "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Role of the domain router", + "name": "role", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the domain ID associated with the router", + "description": "The domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "The second DNS for the router", + "name": "dns2", + "type": "string" + }, + {}, + { + "description": "True if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "The Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "The Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "The result of the health check if available", + "name": "success", + "type": "boolean" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Detailed response generated on running health check", + "name": "details", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "The date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + } + ], + "type": "list" + }, + { + "description": "The list of NICs associated with the router", + "name": "nic", + "response": [ + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", + "description": "The gateway of the NIC", "name": "gateway", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -122672,169 +122760,116 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" } ], "type": "set" }, { - "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", + "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public netmask for the router", + "description": "The public netmask for the router", "name": "publicnetmask", "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 project name of the address", - "name": "project", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "The Network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The Template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - {}, - { - "description": "the Pod name for the router", + "description": "The Pod name for the router", "name": "podname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "The version of Template", + "name": "version", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the public IP address for the router", - "name": "publicip", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" } ] @@ -122845,11 +122880,11 @@ "name": "updateVolume", "params": [ { - "description": "The chain info of the volume", + "description": "New name of the volume", "length": 255, - "name": "chaininfo", + "name": "name", "required": false, - "since": "4.4", + "since": "4.16", "type": "string" }, { @@ -122861,34 +122896,28 @@ "type": "string" }, { - "description": "new name of the volume", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, - "since": "4.16", + "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", - "length": 255, - "name": "displayvolume", - "required": false, - "type": "boolean" - }, - { - "description": "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 disk volume", "length": 255, - "name": "customid", + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "uuid" }, { @@ -122907,440 +122936,446 @@ "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "The chain info of the volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "chaininfo", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.4", + "type": "string" + }, + { + "description": "An optional field, whether to the display the volume to the end User or not.", + "length": 255, + "name": "displayvolume", + "required": false, + "type": "boolean" } ], - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "importVolume,createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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", + "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": "Size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The project name of the VPN", + "name": "project", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "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": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "The chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Display name of the Instance", + "name": "vmdisplayname", "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 VM's disk read in KiB", + "description": "The Instance's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "The Account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "Name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "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": "state of the virtual machine", - "name": "vmstate", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "The status of the volume", + "name": "status", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "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 virtual machine", - "name": "vmname", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" } ] }, @@ -123352,17 +123387,16 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -123372,72 +123406,95 @@ "type": "string" }, { - "description": "", + "description": "The Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "State of the Network provider", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The provider name", + "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "services for this provider", + "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": "UUID of the Network provider", + "name": "id", + "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 destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "since": "3.0.0" }, { - "description": "Updates account information for the authenticated user", + "description": "Updates Account information for the authenticated user", "isasync": false, "name": "updateAccount", "params": [ { - "description": "New name for the account", + "description": "The UUID of the domain where the Account exists", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "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": "Current Account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "New name for the Account", "length": 255, "name": "newname", "required": false, @@ -123452,7 +123509,15 @@ "type": "uuid" }, { - "description": "Details for the account used to store specific parameters", + "description": "The UUID of the dynamic role to set for the Account", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "Details for the Account used to store specific parameters", "length": 255, "name": "accountdetails", "required": false, @@ -123465,151 +123530,268 @@ "required": false, "since": "4.20.1.0", "type": "string" + } + ], + "related": "disableAccount,enableAccount,listAccounts", + "response": [ + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "The UUID of the domain where the account exists", - "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "The UUID of the dynamic role to set for the account", - "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", - "required": false, - "type": "uuid" - } - ], - "related": "disableAccount,enableAccount,listAccounts", - "response": [ + "description": "The total volume being used by this Account", + "name": "volumetotal", + "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) available to be used for this account", - "name": "primarystorageavailable", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "The total number of VPCs the Account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "The name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "The total secondary storage space (in GiB) available to be used for this account", "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, + {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "The total number of CPU cores owned by account", + "name": "cputotal", + "type": "long" + }, + {}, + { + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the 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 templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The list of ACL groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total memory (in MB) the account can own", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "The total memory (in MB) the account can own", "name": "memorylimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "The total volume which can be used by this Account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "The total number of Instances running for this Account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "The state of the account", + "name": "state", + "type": "string" + }, + { + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "The date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "The total number of public IP addresses available for this Account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "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) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "The Network domain", + "name": "networkdomain", + "type": "string" + }, + { + "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", + "type": "long" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the list of users associated with account", + "description": "The list of users associated with account", "name": "user", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user name", + "description": "The user name", "name": "username", "type": "string" }, @@ -123619,404 +123801,257 @@ "type": "resourceiconresponse" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "The API key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The user state", + "name": "state", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "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 state", - "name": "state", + "description": "The user ID", + "name": "id", "type": "string" }, { - "description": "the user lastname", + "description": "The user lastname", "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the 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" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", "type": "apikeyaccess" }, { - "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 domain name of the user", + "description": "The domain name of the user", "name": "domain", "type": "string" } ], "type": "list" }, - {}, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" - }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the id of the account", - "name": "id", + "description": "The default zone of the Account", + "name": "defaultzoneid", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "The total number of 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", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "The total number of public IP addresses allocated for this Account", + "name": "iptotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "Name of the Domain the Account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "The total volume available for this Account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", + "description": "The total number of Instances 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 snapshots available for this account", - "name": "snapshotavailable", + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "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 projects the account can own", + "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 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 default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The name of the Account", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "The total number of Snapshots stored by this Account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - {}, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "The total number of Networks owned by Account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "True if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "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 CPU cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "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 memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of 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 gpus the account can own", - "name": "gpulimit", + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "The ID of the Account", + "name": "id", "type": "string" - }, - { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" } ] }, @@ -124026,150 +124061,148 @@ "name": "addSecondaryStorage", "params": [ { - "description": "the URL for the secondary storage", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].copytemplatesfromothersecondarystorages=true", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { - "description": "the Zone ID for the secondary storage", + "description": "The Zone ID for the secondary storage", "length": 255, "name": "zoneid", "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "The URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" } ], "related": "listSwifts", "response": [ { - "description": "the url of the image store", - "name": "url", + "description": "The ID of the image store", + "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "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": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the name of the image store", - "name": "name", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the host's currently used disk size", + "description": "The host's currently used disk size", "name": "disksizeused", "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "The provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "The name of the image store", + "name": "name", + "type": "string" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "The protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "The scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "The URL of the image store", + "name": "url", "type": "string" }, { - "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": "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": "Updates properties of an Instance. The Instance has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. Therefore, stop the Instance manually before issuing this call.", "isasync": false, "name": "updateVirtualMachine", "params": [ { - "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "description": "List of security group ids to be applied on the Instance.", "length": 255, - "name": "deleteprotection", + "name": "securitygroupids", + "related": "", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "list" }, { - "description": "instance name of the user vm", + "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": "instancename", + "name": "cleanupdetails", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "New host name of the Instance. The Instance has to be stopped/started for this update to take affect", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "since": "4.4", + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Group of the Instance", "length": 255, - "name": "displayvm", + "name": "group", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "description": "User generated name", "length": 255, - "name": "name", + "name": "displayname", "required": false, - "since": "4.4", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "Used to specify the parameters values for the variables in userdata.", "length": 255, "name": "userdatadetails", "required": false, @@ -124177,1383 +124210,1598 @@ "type": "map" }, { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "description": "DHCP options which are passed to the Instance on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "isdynamicallyscalable", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the ID of the userdata", + "description": "Comma separated list of security groups names that going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "userdataid", + "name": "securitygroupnames", "related": "", "required": false, - "since": "4.18", - "type": "uuid" + "type": "list" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "leaseduration", "required": false, - "type": "list" + "since": "4.21.0", + "type": "integer" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", "length": 255, - "name": "leaseexpiryaction", + "name": "deleteprotection", "required": false, - "since": "4.21.0", - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "description": "True if high-availability is enabled for the Instance, false otherwise", "length": 255, "name": "haenable", "required": false, "type": "boolean" }, { - "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": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", "length": 255, - "name": "securitygroupnames", - "related": "", + "name": "details", "required": false, - "type": "list" + "type": "map" }, { - "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", + "description": "The ID of the Instance", "length": 255, - "name": "leaseduration", - "required": false, - "since": "4.21.0", - "type": "integer" + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "user generated name", + "description": "The ID of the userdata", "length": 255, - "name": "displayname", + "name": "userdataid", + "related": "", "required": false, - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "An optional binary data that can be sent to the Instance 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.12", + "since": "4.16.0", "type": "string" }, { - "description": "the ID of the OS type that best represents this 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": "ostypeid", - "related": "addGuestOs", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "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": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "leaseexpiryaction", "required": false, - "type": "map" + "since": "4.21.0", + "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory. This can be updated only when dynamic scaling is enabled on Template, service offering and the corresponding global setting", "length": 255, - "name": "cleanupdetails", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "An optional field, whether to the display the Instance to the end User or not.", + "length": 255, + "name": "displayvm", "required": false, - "since": "4.16.0", - "type": "string" + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The ID of the OS type that best represents this Instance.", "length": 255, - "name": "customid", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "since": "4.4", + "type": "uuid" + }, + { + "description": "An optional URL encoded string that can be passed to the Instance upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, { - "description": "group of the virtual machine", + "description": "Instance name of the User Instance", "length": 255, - "name": "group", + "name": "instancename", "required": false, + "since": "4.4", "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance 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", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The project ID of the Instance", + "name": "projectid", + "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 id of the vm", - "name": "projectid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "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 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 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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "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 Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "device type of the root volume", + "description": "Device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" + }, + { + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", + "description": "The broadcast URI of the NIC", "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", + "description": "The isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The type of the NIC", + "name": "type", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The ID of the NIC", + "name": "id", "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 ID of the nic", - "name": "id", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the 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": "Type of adapter if available", - "name": "adaptertype", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", + "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "The Account associated with the Instance", "name": "account", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, { "description": "Instance lease duration in days", "name": "leaseduration", "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "the name of the vgpu profile to which service offering is linked", "name": "vgpuprofilename", "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 Instance", + "name": "hostid", + "type": "string" + }, { "description": "the maximum number of display heads", "name": "maxheads", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "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": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "set" }, { - "description": "tag value", - "name": "value", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project name where tag belongs to", + "description": "The project name of the group", "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", + "description": "The Account owning the security group", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "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": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the group", + "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 number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", + "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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the protocol of the security group rule", + "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", + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the 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 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": "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 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", + "description": "Security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "The ID of the security group", + "name": "id", + "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 list of ingress rules associated with the security group", + "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": "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", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "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" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "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": "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": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" - } - ], - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the 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": "Security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the project name of the group", + "description": "The project name where tag belongs to", "name": "project", "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": "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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The password (if exists) of the Instance", + "name": "password", "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 Instance", + "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": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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" + } + ], + "type": "set" }, { - "description": "the write (IO) of disk on the VM", + "description": "The write (IO) of disk on the Instance", "name": "diskiowrite", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + } + ] + }, + { + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", + "params": [ + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "Disables specified Account.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "Disables specified Account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "If true, only lock the Account; else disable the Account", + "length": 255, + "name": "lock", + "required": true, "type": "boolean" + } + ], + "related": "enableAccount,listAccounts", + "response": [ + { + "description": "The total number of projects being administrated by this Account", + "name": "projecttotal", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "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 total number of Templates which can be created by this Account", + "name": "templatelimit", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The total number of projects the Account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The default zone of the Account", + "name": "defaultzoneid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The total number of Instances running for this Account", + "name": "vmrunning", "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The total number of public IP addresses available for this Account to acquire", + "name": "ipavailable", + "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 object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "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 state of the virtual machine", - "name": "state", - "type": "string" + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The total volume available for this Account", + "name": "volumeavailable", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "The date when this account was created", + "name": "created", "type": "date" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "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 total number of Templates available to be created by this Account", + "name": "templateavailable", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "Details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "The total number of Networks owned by Account", + "name": "networktotal", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The total number of Templates which have been created by this Account", + "name": "templatetotal", "type": "long" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The total number of Snapshots stored by this Account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The total number of Networks the Account can own", + "name": "networklimit", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the total number of backups available to this account", + "name": "backupavailable", "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The total number of VPCs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "The list of ACL groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The state of the account", + "name": "state", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - } - ] - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,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": "listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - } - ], - "related": "enableAccount,listAccounts", - "response": [ - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "The total number of Networks available to be created for this Account", + "name": "networkavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", "type": "string" }, + {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "name of the Domain the account belongs to", + "description": "Name of the Domain the Account belongs to", "name": "domain", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the name of the account", - "name": "name", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "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", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { @@ -125562,392 +125810,206 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "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 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", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" - }, - { - "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 total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The total number of public IP addresses allocated for this Account", + "name": "iptotal", "type": "long" }, { - "description": "the total number of 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" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "The total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this account", + "description": "The total number of Instances 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 templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the 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 number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the list of users associated with account", + "description": "The list of users associated with account", "name": "user", "response": [ { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user state", + "description": "The user state", "name": "state", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "description": "The source type of the user in lowercase, such as native, ldap, saml2", "name": "usersource", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "The user name", + "name": "username", + "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 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "The boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "True if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", + "description": "The Account name of the user", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", + "description": "The total number of CPU cores the account can own", "name": "cpulimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "The total number of CPU cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "The ID of the Account", + "name": "id", + "type": "string" }, { - "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 network domain", - "name": "networkdomain", - "type": "string" + "description": "True if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "The tagged resource limit and count for the account", @@ -125955,58 +126017,43 @@ "type": "list" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "The name of the Account", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" } ] @@ -126017,19 +126064,19 @@ "name": "listDomains", "params": [ { - "description": "flag to display the resource icon for domains", + "description": "List domain by domain name.", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List domain by domain ID.", + "description": "Tag for resource type to return usage", "length": 255, - "name": "id", - "related": "listDomains,listDomains", + "name": "tag", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { "description": "", @@ -126038,13 +126085,6 @@ "required": false, "type": "integer" }, - { - "description": "List domain by domain name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "List domains by domain level.", "length": 255, @@ -126053,11 +126093,11 @@ "type": "integer" }, { - "description": "", + "description": "Flag to display the resource icon for domains", "length": 255, - "name": "page", + "name": "showicon", "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", @@ -126067,815 +126107,662 @@ "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Tag for resource type to return usage", + "description": "List domain by domain ID.", "length": 255, - "name": "tag", + "name": "id", + "related": "listDomains,listDomains", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" + }, + { + "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" } ], "related": "listDomains", "response": [ { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "The total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the name of the domain", - "name": "name", + "description": "The total number of Snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain ID of the parent domain", + "description": "The domain ID of the parent domain", "name": "parentdomainid", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "The total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "The total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "Details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "The total number of Templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "The total number of CPU cores the domain can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "The total number of Snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "The total number of Networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", + "description": "The total number of Networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "The total memory (in MB) available to be created for this domain", "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "The total number of VPCs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "The total number of VPCs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", - "type": "string" + "description": "The total number of public IP addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, + {}, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "The total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "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 available to be created for this domain", - "name": "cpuavailable", + "description": "The domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "The total number of Instances 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 date when this domain was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "The total number of VPCs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "The total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "The total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "The total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "The total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "The total number of Instances deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "The total number of Templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "The total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "The total number of public IP addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "The total number of Snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" + "description": "The total number of Templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "The level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "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 primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "The total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "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", + "description": "The total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "The state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "The total number of Networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "The ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "Whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "The total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "The total number of public IP addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "The total number of Instances that can be deployed by this domain", + "name": "vmlimit", + "type": "string" } ] }, { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "description": "Resets the UserData for Instance. The Instance must be in a \"Stopped\" state.", "isasync": false, "name": "resetUserDataForVirtualMachine", "params": [ { - "description": "an optional project for the virtual machine", + "description": "An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "An optional Account for the Instance. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the userdata", + "description": "The ID of the Instance", "length": 255, - "name": "userdataid", - "related": "", - "required": false, + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "The ID of the userdata", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "userdataid", + "related": "", "required": false, "type": "uuid" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "An optional project for the Instance", + "length": 255, + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "Used to specify the parameters values for the variables in userdata.", "length": 255, "name": "userdatadetails", "required": false, "type": "map" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The pool type of the Instance", + "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": "Base64 string containing the user data", - "name": "userdata", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - {}, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "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 domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "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 date when this Instance was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "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 target memory in VM (KiB)", + "description": "The target memory in Instance (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the read (IO) of disk on the VM", + "description": "The read (IO) of disk on the Instance", "name": "diskioread", "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", - "type": "string" - }, - { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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", + "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 name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The memory allocated for the Instance", + "name": "memory", "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The IPv6 address of Network", + "name": "ip6address", "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 type of the NIC", + "name": "type", "type": "string" }, { @@ -126884,531 +126771,541 @@ "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", + "description": "The Secondary IPv4 addr of NIC", "name": "secondaryip", "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", + "description": "Public IP address ID associated with this NIC via Static NAT rule", "name": "publicipid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "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 name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the netmask of the nic", - "name": "netmask", - "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 isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolated private VLAN type if available", + "description": "The isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, + "description": "The IP address of the NIC", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "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 Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the ID of the security group", + "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 number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", + "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the code for the ICMP message response", + "description": "The code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the ending IP of the security group rule ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", + "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": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag value", + "name": "value", "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" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", + "description": "The list of Instance IDs associated with this Security Group", "name": "virtualmachineids", "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", + "description": "The Account owning the security group", "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "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": "security group name", + "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" - }, - { - "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" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "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": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The 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 ending IP of the security group rule ", "name": "endport", "type": "integer" } @@ -127416,139 +127313,168 @@ "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "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" } ], "type": "set" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The ID of the Instance", + "name": "id", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "The description of the affinity group", + "name": "description", "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 name of the affinity group", - "name": "project", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "The ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -127557,106 +127483,232 @@ "type": "map" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + {}, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the memory used by the VM in KiB", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The memory used by the Instance in KiB", "name": "memorykbs", "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "Instance 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 amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The name of the host for the Instance", + "name": "hostname", + "type": "string" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + {}, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.18.0" }, { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "description": "Deletes a Template from the system. All Instances using the deleted Template will not be affected.", "isasync": true, "name": "deleteTemplate", "params": [ { - "description": "Force delete a template.", + "description": "Force delete a Template.", "length": 255, "name": "forced", "required": false, @@ -127664,13 +127716,21 @@ "type": "boolean" }, { - "description": "the ID of zone of the template", + "description": "The ID of zone of the Template", "length": 255, "name": "zoneid", "related": "listZones", "required": false, "type": "uuid" }, + { + "description": "The ID of the Template", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, { "description": "Necessary if the template's type is system.", "length": 255, @@ -127678,36 +127738,28 @@ "required": false, "since": "4.20.0", "type": "boolean" - }, - { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, { - "description": "true if operation is executed successfully", + "description": "True 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" } @@ -127719,59 +127771,52 @@ "name": "listNetworkACLLists", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List network ACLs by specified name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network ACLs by VPC ID", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "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": "Lists network ACL with the specified ID.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "projectid", + "related": "", "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" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -127779,20 +127824,19 @@ "type": "uuid" }, { - "description": "list network ACLs by network ID", + "description": "List network ACLs by VPC ID", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -127802,26 +127846,34 @@ "type": "boolean" }, { - "description": "list network ACLs by specified name", + "description": "List network ACLs by network ID", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "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": "", + "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" } ], "related": "createNetworkACLList", "response": [ { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The Name of the ACL", + "name": "name", + "type": "string" }, { "description": "Description of the ACL", @@ -127830,23 +127882,18 @@ }, {}, { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the ACL", + "description": "The ID of the ACL", "name": "id", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, @@ -127856,19 +127903,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" } ] }, { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "description": "Archives (moves) a Snapshot on primary storage to secondary storage", "isasync": true, "name": "archiveSnapshot", "params": [ { - "description": "The ID of the snapshot", + "description": "The ID of the Snapshot", "length": 255, "name": "id", "related": "copySnapshot,archiveSnapshot,listSnapshots", @@ -127878,149 +127930,148 @@ ], "related": "copySnapshot,listSnapshots", "response": [ + { + "description": "The Account associated with the Snapshot", + "name": "account", + "type": "string" + }, { "description": "state of the disk volume", "name": "volumestate", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "The domain name of the Snapshot's Account", + "name": "domain", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "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": "ID of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "Type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "The project name of the Snapshot", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The date the Snapshot was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The 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 ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, { "description": "state of the snapshot on the datastore", "name": "datastorestate", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", + "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": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "name of the snapshot", - "name": "name", + "description": "Display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", @@ -128028,107 +128079,110 @@ "type": "long" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "Name of the Snapshot", + "name": "name", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "Valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "The domain ID of the Snapshot's Account", + "name": "domainid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, + {}, + { + "description": "Physical size of backed up Snapshot on image store", + "name": "physicalsize", + "type": "long" + }, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "The project id of the Snapshot", + "name": "projectid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "ID of the Snapshot", + "name": "id", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "The parent name of the Snapshot", + "name": "parentname", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "The type of the Snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "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": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The parent ID of the Snapshot", + "name": "parent", "type": "string" } ] }, { - "description": "Updates site to site vpn local gateway", + "description": "Updates site to site VPN local gateway", "isasync": true, "name": "updateVpnGateway", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "An optional field, whether to the display the VPN to the end User or not", "length": 255, "name": "fordisplay", "required": false, @@ -128136,86 +128190,94 @@ "type": "boolean" }, { - "description": "id of customer gateway", + "description": "ID of customer gateway", "length": 255, "name": "id", "related": "updateVpnGateway", "required": true, "type": "uuid" + }, + { + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner", - "name": "account", + "description": "The VPN gateway ID", + "name": "id", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "The project name", + "name": "project", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "The owner", + "name": "account", "type": "string" }, { - "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", + "description": "The project id", "name": "projectid", "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "The VPC id of this gateway", + "name": "vpcid", "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain path of the owner", + "name": "domainpath", "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", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "The domain id of the owner", + "name": "domainid", "type": "string" } ], @@ -128227,7 +128289,7 @@ "name": "releaseDedicatedGuestVlanRange", "params": [ { - "description": "the ID of the dedicated guest vlan range", + "description": "The ID of the dedicated guest VLAN range", "length": 255, "name": "id", "related": "", @@ -128236,28 +128298,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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "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" + } ] }, { @@ -128265,13 +128327,6 @@ "isasync": false, "name": "deleteSecurityGroup", "params": [ - { - "description": "the account of the security group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "The ID of the security group. Mutually exclusive with id parameter", "length": 255, @@ -128280,7 +128335,7 @@ "type": "string" }, { - "description": "the domain ID of account owning the security group", + "description": "The domain ID of account owning the security group", "length": 255, "name": "domainid", "related": "listDomains", @@ -128288,13 +128343,20 @@ "type": "uuid" }, { - "description": "the project of the security group", + "description": "The project of the security group", "length": 255, "name": "projectid", "related": "", "required": false, "type": "uuid" }, + { + "description": "The account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, @@ -128305,27 +128367,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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", + "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" } ] }, @@ -128335,16 +128397,16 @@ "name": "createGuiTheme", "params": [ { - "description": "A description for the theme.", - "length": 4096, - "name": "description", + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "length": 255, + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", "length": 65535, - "name": "jsonconfiguration", + "name": "accountids", "required": false, "type": "string" }, @@ -128356,16 +128418,16 @@ "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", "length": 65535, - "name": "commonnames", + "name": "css", "required": false, "type": "string" }, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "length": 65535, - "name": "domainids", + "description": "A description for the theme.", + "length": 4096, + "name": "description", "required": false, "type": "string" }, @@ -128377,23 +128439,23 @@ "type": "boolean" }, { - "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", - "length": 255, - "name": "ispublic", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", "length": 65535, - "name": "css", + "name": "commonnames", "required": false, "type": "string" }, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", "length": 65535, - "name": "accountids", + "name": "domainids", "required": false, "type": "string" } @@ -128401,19 +128463,19 @@ "related": "", "response": [ { - "description": "ID of the custom GUI theme.", - "name": "id", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "name": "commonnames", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", - "type": "boolean" + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" }, {}, { @@ -128422,55 +128484,55 @@ "type": "string" }, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "accountids", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" + }, + { + "description": "Description of the GUI theme.", + "name": "description", "type": "string" }, { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "jsonconfiguration", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", "name": "ispublic", "type": "boolean" }, { - "description": "Name of the GUI theme.", - "name": "name", - "type": "string" - }, - { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", - "type": "string" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, { "description": "When the GUI theme was created.", "name": "created", "type": "date" }, + {}, { - "description": "Description of the GUI theme.", - "name": "description", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.21.0.0" @@ -128481,17 +128543,17 @@ "name": "importVolume", "params": [ { - "description": "import volume for the project", + "description": "the ID of the disk offering linked to the volume", "length": 255, - "name": "projectid", + "name": "diskofferingid", "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "description": "an optional account for the volume. Must be used with domainId.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -128503,6 +128565,13 @@ "required": false, "type": "uuid" }, + { + "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the path of the volume", "length": 255, @@ -128511,20 +128580,13 @@ "type": "string" }, { - "description": "the ID of the disk offering linked to the volume", + "description": "import volume for the project", "length": 255, - "name": "diskofferingid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, - { - "description": "an optional account for the volume. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the ID of the storage pool", "length": 255, @@ -128537,458 +128599,459 @@ "related": "createVolume,listVolumes,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": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "Name of the Instance", + "name": "vmname", "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", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", + "description": "ID of the Snapshot from which this volume was created", "name": "snapshotid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "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", + "name": "jobstatus", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, {}, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "state of the virtual machine", + "description": "State of the Instance", "name": "vmstate", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "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": "name of the availability zone", - "name": "zonename", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Type of the Instance", + "name": "vmtype", "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": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 account associated with the tag", - "name": "account", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "Min IOPS of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "True if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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 write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "The date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" + }, + { + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "The state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Max IOPS of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" } ], "since": "4.19.1" }, { - "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.", + "description": "Creates a Template of an Instance. The Instance must be in a STOPPED state. A Template created from this command is automatically designated as a private Template visible to the account that created it.", "isasync": true, "name": "createTemplate", "params": [ { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", + "description": "True if the Template requires HVM, false otherwise", "length": 255, - "name": "arch", + "name": "requireshvm", "required": false, - "since": "4.20.2", - "type": "string" + "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "the zone for the template. Can be specified with snapshot only", "length": 255, - "name": "requireshvm", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "since": "4.19.0", + "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" }, { "description": "an optional accountName. Must be used with domainId.", @@ -128999,89 +129062,73 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "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 the template supports the sshkey upload feature; default is false", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", "length": 255, - "name": "sshkeyenabled", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20.2", + "type": "string" }, { - "description": "create template for the project", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "projectid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "True if the Template supports the password reset feature; default is false", "length": 255, "name": "passwordenabled", "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", - "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", - "required": false, - "type": "uuid" - }, - { - "description": "true if this template is a public template, false otherwise", + "description": "True if this Template is a public Template, false otherwise", "length": 255, "name": "ispublic", "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": "The ID of the OS Type that best represents the OS of this Template.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": false, + "name": "ostypeid", + "related": "addGuestOs", + "required": true, "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "The tag for this Template.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "templatetag", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "string" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "description": "The ID of the Snapshot the Template is being created from. Either this parameter, or volumeId has to be passed in", + "length": 255, + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the template", + "description": "32 or 64 bit", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "The ID of the disk volume the Template is being created from. Either this parameter, or snapshotId has to be passed in", "length": 255, "name": "volumeid", "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", @@ -129089,39 +129136,54 @@ "type": "uuid" }, { - "description": "the tag for this template.", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "length": 255, - "name": "templatetag", + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "32 or 64 bit", + "description": "Create Template for the project", "length": 255, - "name": "bits", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "True if the Template supports the SSHkey upload feature; default is false", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": true, - "type": "uuid" + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "True if this Template is a featured Template, false otherwise", "length": 255, "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the zone for the template. Can be specified with snapshot only", + "description": "The display text of the Template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "Optional, Instance ID. If this presents, it is going to create a baremetal Template for Instance this ID refers to. This is only for Instance whose hypervisor type is BareMetal", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "since": "4.19.0", "type": "uuid" @@ -129130,364 +129192,364 @@ "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, + {}, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "path of the Domain the template belongs to", + "description": "Path of the Domain the template belongs to", "name": "domainpath", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The ID of the zone for this Template", + "name": "zoneid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "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 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 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": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "The processor bit size", + "name": "bits", + "type": "int" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "The Template ID", + "name": "id", + "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The Template name", + "name": "name", "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", + "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 in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The tag of this Template", + "name": "templatetag", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "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", - "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 URL which the template/iso is registered from", - "name": "url", + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "The id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "The date this Template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "Additional key/value details tied with Template", + "name": "details", "type": "map" }, { - "description": "the template display text", + "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": "the ID of the zone for this template", - "name": "zoneid", + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" }, {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "the current status of the latest async job acting 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the date this template was created", + "description": "The date this Template was created", "name": "created", "type": "date" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the status of the template", - "name": "status", + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The project name of the Template", + "name": "project", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The type of the Template", + "name": "templatetype", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the 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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "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 name", - "name": "name", + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the size of the template", + "description": "The size of the Template", "name": "size", "type": "long" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, - {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "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 name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" } ] }, { - "description": "Restores an existing stopped or deleted VM using a VM backup", + "description": "Restores an existing stopped or deleted Instance using an Instance backup", "isasync": true, "name": "restoreBackup", "params": [ @@ -129501,25 +129563,25 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "True 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" } @@ -129532,16 +129594,9 @@ "name": "uploadCustomCertificate", "params": [ { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, - "type": "string" - }, - { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", "required": true, "type": "string" }, @@ -129560,32 +129615,39 @@ "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", + "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" } ], "related": "", "response": [ - {}, - { - "description": "message of the certificate upload operation", - "name": "message", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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" + }, + {} ] }, { @@ -129593,6 +129655,13 @@ "isasync": false, "name": "listDedicatedClusters", "params": [ + { + "description": "The name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -129601,95 +129670,88 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the cluster", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the cluster", + "description": "The ID of the domain associated with the cluster", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list dedicated clusters by affinity group", + "description": "The ID of the cluster", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "List dedicated clusters by affinity group", "length": 255, - "name": "page", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the cluster", - "name": "clustername", + "description": "The Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "The Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID of the cluster", + "description": "The domain ID of the cluster", "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the dedicated resource", + "description": "The ID of the dedicated resource", "name": "id", "type": "string" }, - {} + {}, + {}, + { + "description": "The name of the cluster", + "name": "clustername", + "type": "string" + } ] }, { @@ -129700,98 +129762,93 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Timestamp when the run got over", + "name": "updated_on", + "type": "date" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "timestamp when the run got over", - "name": "updated_on", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.7.0" }, { - "description": "list Tungsten-Fabric network", + "description": "List Tungsten-Fabric network", "isasync": false, "name": "listTungstenFabricNetwork", "params": [ { - "description": "", + "description": "The uuid of Tungsten-Fabric network", "length": 255, - "name": "page", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "", "length": 255, - "name": "networkuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "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 include public network. Default value is false", + "description": "The ID of zone", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric network name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "Tungsten-Fabric network 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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "Tungsten-Fabric network uuid", "name": "uuid", @@ -129801,6 +129858,11 @@ "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -129824,7 +129886,7 @@ "type": "string" }, { - "description": "zone Id", + "description": "Zone ID", "length": 255, "name": "zoneid", "related": "listZones", @@ -129841,43 +129903,43 @@ ], "related": "addTrafficMonitor", "response": [ - {}, { - "description": "the management IP address of the external firewall", + "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 zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "The ID of the external firewall", + "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "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 timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" - }, - {} + } ] }, { @@ -129897,54 +129959,45 @@ "related": "", "response": [ { - "description": "id of the bgp peer", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, {}, { @@ -129953,41 +130006,50 @@ "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { "description": "the account of the bgp peer", "name": "account", "type": "string" }, - {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { "description": "the project name of the bgp peer", "name": "project", "type": "string" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" } ], "since": "4.20.0" }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "description": "Updates a port forwarding rule. Only the private port and the Instance can be updated.", "isasync": true, "name": "updatePortForwardingRule", "params": [ { - "description": "the ID of the port forwarding rule", + "description": "The ID of the port forwarding rule", "length": 255, "name": "id", "related": "updatePortForwardingRule", @@ -129996,15 +130058,15 @@ "type": "uuid" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -130012,14 +130074,15 @@ "type": "boolean" }, { - "description": "the private end port of the port forwarding rule", + "description": "The ID of the Instance for the port forwarding rule", "length": 255, - "name": "privateendport", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "Instance guest NIC Secondary IP address for the port forwarding rule", "length": 255, "name": "vmguestip", "required": false, @@ -130034,17 +130097,16 @@ "type": "list" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The private start port of the port forwarding rule", "length": 255, - "name": "customid", + "name": "privateport", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the private start port of the port forwarding rule", + "description": "The private end port of the port forwarding rule", "length": 255, - "name": "privateport", + "name": "privateendport", "required": false, "type": "integer" } @@ -130052,240 +130114,240 @@ "related": "", "response": [ { - "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" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "The Instance ID for the port forwarding rule", + "name": "virtualmachineid", + "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 ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", + "description": "The Instance display name for the port forwarding rule", "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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 ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "The Instance IP address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + {}, + { + "description": "The public IP address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "The Instance 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 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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", + "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": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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 domain associated with the tag", - "name": "domain", + "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 public IP address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "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 protocol of the port forwarding rule", - "name": "protocol", - "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": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the 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 state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" } ] }, { - "description": "Acquires and associates a public IP to an account.", + "description": "Acquires and associates a public IP to an Account.", "isasync": true, "name": "associateIpAddress", "params": [ { - "description": "the account to associate 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" + "since": "4.4", + "type": "boolean" }, { - "description": "the VPC you want the IP address to be associated with", + "description": "The ID of the domain to associate with this IP address", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "Deploy VM for the project", + "description": "Region ID from where portable IP is to be associated.", "length": 255, - "name": "projectid", + "name": "regionid", "related": "", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "IP Address to be associated", + "description": "The VPC you want the IP address to be associated with", "length": 255, - "name": "ipaddress", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "The Account to associate with this IP address", "length": 255, - "name": "regionid", - "related": "", + "name": "account", "required": false, - "type": "integer" + "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": "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 ID of the domain to associate with this IP address", + "description": "IP Address to be associated", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "listZones", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "Deploy Instance for the project", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "The ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" } @@ -130293,104 +130355,155 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "The name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "The domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "Is public IP for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "Instance (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": "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": "Instance display name the IP address is assigned to (not null only for static NAT IP)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "True if this IP is for static NAT, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", + "description": "The ID of the zone the public IP address belongs to", "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "Instance id the IP address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "Public IP address ID", + "name": "id", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", + "description": "The list of resource tags associated with IP address", + "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": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "True if this IP is system IP (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "VPC name the IP belongs to", + "name": "vpcname", "type": "string" }, { @@ -130399,158 +130512,107 @@ "type": "string" }, { - "description": "the name of the Network where ip belongs to", + "description": "The name of the Network where IP belongs to", "name": "networkname", "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", + "description": "The domain the public IP address is associated with", "name": "domain", "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": "date the public IP address was acquired", + "description": "Date the public IP address was acquired", "name": "allocated", "type": "date" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "Instance name the IP address is assigned to", + "name": "virtualmachinename", "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": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "The ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "The Account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "The VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "True if the IP address is a source NAT address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "VPC ID the IP belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "The name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" - } + }, + { + "description": "The project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "Instance type the IP address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -130559,48 +130621,48 @@ "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "Storage Pool UUID", + "description": "Cluster UUID", "length": 255, - "name": "storageid", + "name": "clusterid", "required": true, "type": "string" }, { - "description": "Cluster UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "clusterid", + "name": "storageid", "required": true, "type": "string" } ], "related": "", "response": [ - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Delete site to site vpn connection", + "description": "Delete site to site VPN connection", "isasync": true, "name": "deleteVpnConnection", "params": [ { - "description": "id of vpn connection", + "description": "ID of VPN connection", "length": 255, "name": "id", "related": "", @@ -130610,27 +130672,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the 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", + "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" + }, + {} ] }, { @@ -130641,468 +130703,567 @@ "related": "listAlerts", "response": [ { - "description": "the id of the alert", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the alert", "name": "id", "type": "string" }, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "The name of the alert", + "name": "name", + "type": "string" }, { - "description": "description of the alert", + "description": "Description of the alert", "name": "description", "type": "string" }, + { + "description": "The date and time the alert was sent", + "name": "sent", + "type": "date" + }, {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", "name": "type", "type": "short" - }, - {}, - { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", + "description": "Creates a ACL rule in the given Network (the Network has to belong to VPC)", "isasync": true, "name": "createNetworkACL", "params": [ { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "The number of the ACL item, its ordering", + "description": "The ending port of ACL", "length": 255, - "name": "number", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "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": "error code for this ICMP message", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "icmpcode", + "name": "number", "required": false, "type": "integer" }, { - "description": "the ending port of ACL", + "description": "The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "endport", + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "Type of the ICMP message being sent", + "length": 255, + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "fordisplay", + "name": "reason", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "The traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, "name": "traffictype", "required": false, "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The starting port of ACL", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "The Network of the Instance the ACL will be created for", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "An optional field, whether to the display the rule to the end User or not", "length": 255, - "name": "reason", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "scl entry action, allow or deny", + "description": "ACL entry action, allow or deny", "length": 255, "name": "action", "required": false, "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "Error code for this ICMP message", "length": 255, - "name": "icmptype", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the starting port of ACL", + "description": "The network of the Instance the ACL will be created for", "length": 255, - "name": "startport", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ + {}, { - "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 traffic type for the ACL", - "name": "traffictype", + "description": "The protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "The traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "The list of resource tags associated with the Network ACLs", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "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" } ], "type": "list" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "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 ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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": "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 state of the rule", + "name": "state", + "type": "string" }, + {}, { - "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 name of the ACL this item belongs to", - "name": "aclname", + "description": "The ending port of ACL's port range", + "name": "endport", "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 protocol of the ACL", - "name": "protocol", - "type": "string" + "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": "Type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "Number of the ACL Item", "name": "number", "type": "integer" }, - {}, { - "description": "the starting port of ACL's port range", - "name": "startport", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", + "description": "Resets the SSH Key for Instance. The Instance must be in a \"Stopped\" state. [async]", "isasync": true, "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "An optional Account for the SSH key. Must be used with domainId.", "length": 255, - "name": "keypairs", + "name": "account", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "The ID of the Instance", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "keypair", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "Names of the SSH key pairs to be used to login to the Instance", "length": 255, - "name": "account", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "an optional project for the ssh key", + "description": "An optional project for the SSH key", "length": 255, "name": "projectid", "related": "", "required": false, "type": "uuid" + }, + { + "description": "Name of the SSH key pair used to login to the Instance", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The internal memory (KiB) that's free in Instance 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 virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "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 ID of the NIC", + "name": "id", + "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 traffic type of the NIC", + "name": "traffictype", + "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 type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" } ], "type": "set" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { "description": "the VM's primary IP address", @@ -131110,1037 +131271,943 @@ "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The project name of the Instance", + "name": "project", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "The domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "The project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "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": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "The state of the Instance", + "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 gpu card to which service offering is linked", + "name": "gpucardname", "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 Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "The Instance'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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "path of the Domain the security group belongs to", + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "ID of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", + "response": [ + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "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 value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "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", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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" } ], "type": "set" }, { - "description": "the account owning the security group", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "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 number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "The description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "tag value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", + "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", + "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 account associated with the tag", + "description": "Account owning the security group rule", "name": "account", "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" } ], "type": "set" - } - ], - "type": "set" - }, - { - "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": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The User's name who deployed the Instance", + "name": "username", "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "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": "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 type of the nic", - "name": "type", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The group name of the Instance", + "name": "group", + "type": "string" } ] }, @@ -132150,58 +132217,58 @@ "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The ending IP address.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "endip", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The vlan id the ip range sits on", + "description": "The starting IP address.", "length": 255, - "name": "vlan", + "name": "startip", "required": true, "type": "string" }, { - "description": "The ending IP address.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "endip", + "name": "vlan", "required": true, "type": "string" }, { - "description": "The starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "startip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" } ], "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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", + "description": "True 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.0.0" }, @@ -132211,27 +132278,13 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "The ID of the zone in which Kubernetes supported version will be available", "length": 255, "name": "zoneid", "related": "listZones", "required": false, "type": "uuid" }, - { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" - }, { "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", "length": 255, @@ -132241,12 +132294,19 @@ "type": "string" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "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" }, + { + "description": "The name of the Kubernetes supported version", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", "length": 255, @@ -132256,23 +132316,30 @@ "type": "boolean" }, { - "description": "the name of the Kubernetes supported version", + "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": "name", + "name": "checksum", "required": false, "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": "minmemory", + "required": true, + "type": "integer" + }, + { + "description": "The URL of the binaries ISO for Kubernetes supported version", "length": 255, "name": "url", "required": false, "type": "string" }, { - "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" } @@ -132280,96 +132347,101 @@ "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "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 arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, {}, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "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": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "Whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "The enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "The ID of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", + "description": "The ID of the binaries ISO for Kubernetes supported version", "name": "isoid", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the URL of the binaries ISO for Kubernetes supported version", + "name": "isourl", "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 in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, - {}, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "Whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "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": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "The minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, + {}, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "The date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" + }, + { + "description": "The name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" } ] }, @@ -132378,14 +132450,6 @@ "isasync": false, "name": "registerCniConfiguration", "params": [ - { - "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Name of the user data", "length": 255, @@ -132393,6 +132457,13 @@ "required": true, "type": "string" }, + { + "description": "CNI Configuration content to be registered as User data", + "length": 1048576, + "name": "cniconfig", + "required": false, + "type": "string" + }, { "description": "comma separated list of variables declared in user data content", "length": 255, @@ -132400,6 +132471,14 @@ "required": false, "type": "string" }, + { + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "an optional account for the user data. Must be used with domainId.", "length": 255, @@ -132414,63 +132493,57 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "CNI Configuration content to be registered as User data", - "length": 1048576, - "name": "cniconfig", - "required": false, - "type": "string" } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", + "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": "4.21.0" }, { - "description": "Link or unlink a userdata to a template.", + "description": "Link or unlink a userdata to a Template.", "isasync": false, "name": "linkUserDataToTemplate", "params": [ { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "description": "The ID of the ISO for the Instance", "length": 255, - "name": "userdatapolicy", + "name": "isoid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the ISO for the virtual machine", + "description": "The ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISO", "length": 255, - "name": "isoid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "userdataid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "The ID of the Template for the Instance", "length": 255, "name": "templateid", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", @@ -132478,116 +132551,38 @@ "type": "uuid" }, { - "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "description": "An optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatapolicy", "required": false, - "type": "uuid" + "type": "string" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 the domain to which the template belongs", - "name": "domain", + "description": "The type of the Template", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { @@ -132596,252 +132591,329 @@ "type": "resourceiconresponse" }, { - "description": "the template display text", - "name": "displaytext", + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "The name of the secondary storage host for the Template", + "name": "hostname", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, + {}, { - "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", + "type": "string" }, { - "description": "the template ID", + "description": "The Template ID", "name": "id", "type": "string" }, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "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 the template is managed across all Zones, false otherwise", - "name": "crossZones", + "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": "the processor bit size", + "description": "The processor bit size", "name": "bits", "type": "int" }, { - "description": "the project name of the template", - "name": "project", + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of the zone for this Template", + "name": "zonename", "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": "the template name", - "name": "name", + "description": "The Template display text", + "name": "displaytext", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "The size of the Template", + "name": "size", + "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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "The tag of this Template", + "name": "templatetag", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "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 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 Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "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 name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, + {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "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": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "The project ID of the Template", + "name": "projectid", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the 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", + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "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": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "The id of userdata linked to this Template", + "name": "userdataid", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "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": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" } ], "since": "4.18.0" @@ -132851,6 +132923,21 @@ "isasync": false, "name": "listCustomActions", "params": [ + { + "description": "List actions whether they are enabled or not", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "uuid of the custom action", + "length": 255, + "name": "id", + "related": "listCustomActions", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -132859,11 +132946,11 @@ "type": "integer" }, { - "description": "List actions whether they are enabled or not", + "description": "Name of the custom action", "length": 255, - "name": "enabled", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -132881,9 +132968,9 @@ "type": "uuid" }, { - "description": "Type of the resource for actions", + "description": "ID of a resource for actions", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": false, "type": "string" }, @@ -132895,41 +132982,15 @@ "type": "string" }, { - "description": "ID of a resource for actions", - "length": 255, - "name": "resourceid", - "required": false, - "type": "string" - }, - { - "description": "Name of the custom action", + "description": "Type of the resource for actions", "length": 255, - "name": "name", + "name": "resourcetype", "required": false, "type": "string" - }, - { - "description": "uuid of the custom action", - "length": 255, - "name": "id", - "related": "listCustomActions", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - { - "description": "ID of the extension that this custom action belongs to", - "name": "extensionid", - "type": "string" - }, - { - "description": "Resource type for which the action is available", - "name": "resourcetype", - "type": "string" - }, - {}, { "description": "List of the parameters for the action", "name": "parameters", @@ -132940,14 +133001,9 @@ "type": "string" }, { - "description": "Validation format for value of the parameter. Available for specific types", - "name": "validationformat", - "type": "string" - }, - { - "description": "Name of the parameter", - "name": "name", - "type": "string" + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" }, { "description": "Comma-separated list of options for value of the parameter", @@ -132955,9 +133011,14 @@ "type": "list" }, { - "description": "Whether the parameter is required or not", - "name": "required", - "type": "boolean" + "description": "Name of the parameter", + "name": "name", + "type": "string" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" } ], "type": "list" @@ -132968,18 +133029,13 @@ "type": "list" }, { - "description": "Name of the custom action", - "name": "name", - "type": "string" - }, - { - "description": "Description of the custom action", - "name": "description", + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", "type": "string" }, { - "description": "Name of the extension that this custom action belongs to", - "name": "extensionname", + "description": "Name of the custom action", + "name": "name", "type": "string" }, { @@ -132988,28 +133044,35 @@ "type": "boolean" }, { - "description": "Message that will be used on failure during execution of the action", - "name": "errormessage", + "description": "ID of the custom action", + "name": "id", "type": "string" }, { - "description": "Message that will be used on successful execution of the action", - "name": "successmessage", + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, + {}, { "description": "Creation timestamp of the custom action", "name": "created", "type": "date" }, { - "description": "Details of the custom action", - "name": "details", - "type": "map" + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", + "type": "string" }, + {}, { - "description": "ID of the custom action", - "name": "id", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Description of the custom action", + "name": "description", "type": "string" }, { @@ -133017,14 +133080,23 @@ "name": "timeout", "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Resource type for which the action is available", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, + { + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -133036,13 +133108,6 @@ "isasync": false, "name": "listGlobalLoadBalancerRules", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -133051,29 +133116,37 @@ "type": "map" }, { - "description": "", + "description": "Region ID", "length": 255, - "name": "pagesize", + "name": "regionid", + "related": "", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "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": "The ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": false, + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -133081,11 +133154,12 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "", "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.", @@ -133095,286 +133169,284 @@ "type": "boolean" }, { - "description": "the ID of the global load balancer rule", + "description": "", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "region ID", + "description": "", "length": 255, - "name": "regionid", - "related": "", + "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.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "global load balancer rule ID", - "name": "id", - "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": "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 project id of the load balancer", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "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": "List of load balancer rules that are part of GSLB rule", + "description": "List of Load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the public ip address", + "description": "The Load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "The public IP address", "name": "publicip", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "The name of the zone the Load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "The domain ID of the Load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "The protocol of the Load Balancer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "The list of resource tags associated with Load balancer", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "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 public port", - "name": "publicport", - "type": "string" + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "The Account of the Load balancer rule", + "name": "account", "type": "string" }, { - "description": "the description of the load balancer", + "description": "The description of the Load balancer", "name": "description", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "The project ID of the Load balancer", + "name": "projectid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "The name of the Load balancer", + "name": "name", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "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 state of the rule", + "name": "state", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The public port", + "name": "publicport", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "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 domain of the load balancer rule", - "name": "domain", + "description": "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "The public IP address ID", + "name": "publicipid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "The project name of the Load balancer", + "name": "project", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "Region Id in which global load balancer is created", + "description": "Region ID in which global Load balancer is created", "name": "regionid", "type": "integer" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "Name of the global Load balancer rule", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The project name of the Load balancer", + "name": "project", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "The project ID of the Load balancer", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "Global Load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "The Account of the Load balancer rule", + "name": "account", + "type": "string" + }, + {}, + { + "description": "DNS domain name given for the global Load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the domain ID of the load balancer rule", + "description": "Session persistence method used for the global Load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, + { + "description": "The domain ID of the Load balancer rule", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "The domain of the Load balancer rule", + "name": "domain", + "type": "string" } ] }, @@ -133394,25 +133466,25 @@ ], "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": "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" }, {} ] @@ -133423,7 +133495,7 @@ "name": "releaseDedicatedCluster", "params": [ { - "description": "the ID of the Cluster", + "description": "The ID of the Cluster", "length": 255, "name": "clusterid", "related": "addCluster,updateCluster", @@ -133432,28 +133504,28 @@ } ], "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", + "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" + }, + {}, + {} ] }, { @@ -133462,7 +133534,7 @@ "name": "getKubernetesClusterConfig", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "The ID of the Kubernetes cluster", "length": 255, "name": "id", "related": "createKubernetesCluster,startKubernetesCluster", @@ -133472,30 +133544,30 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "The ID of the container cluster", + "name": "id", "type": "string" }, { - "description": "Name of the container cluster", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the id of the container cluster", - "name": "id", + "description": "The config data of the cluster", + "name": "configdata", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the container cluster", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -133507,7 +133579,7 @@ "name": "deleteAutoScalePolicy", "params": [ { - "description": "the ID of the autoscale policy", + "description": "The ID of the autoscale policy", "length": 255, "name": "id", "related": "listAutoScalePolicies", @@ -133516,28 +133588,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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The 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" + } ] }, { @@ -133555,27 +133627,27 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", + "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", + "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" @@ -133595,40 +133667,40 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {}, + {} ] }, { - "description": "List internal LB VMs.", + "description": "List internal LB Instances.", "isasync": false, "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List by Network ID", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, @@ -133640,21 +133712,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": "", + "description": "The Zone ID of the Internal LB Instance", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "The Pod ID of the Internal LB Instance", "length": 255, "name": "podid", "related": "createManagementNetworkIpRange", @@ -133662,100 +133728,106 @@ "type": "uuid" }, { - "description": "the ID of the Internal LB VM", + "description": "List Internal LB Instances by VPC", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the Internal LB Instance", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The state of the Internal LB Instance", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the state of the Internal LB VM", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by network id", + "description": "The host ID of the Internal LB Instance", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false", "length": 255, - "name": "keyword", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "forvpc", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the host ID of the Internal LB VM", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the Internal LB VM", + "description": "If true is passed for this parameter, list only VPC Internal LB Instances", "length": 255, - "name": "name", + "name": "forvpc", + "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": "List Internal LB VMs by VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", "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 resources by account. Must be used with the domainId parameter.", + "description": "The name of the Internal LB Instance", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" } @@ -133763,479 +133835,479 @@ "related": "listRouters", "response": [ { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the link local netmask for the router", + "description": "The link local netmask for the router", "name": "linklocalnetmask", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check if available", - "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 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 result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - } - ], - "type": "list" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the template ID for the router", + "description": "The Template ID for the router", "name": "templateid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "if this router is an redundant virtual router", + "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": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "The state of the router", + "name": "state", + "type": "state" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "The domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the version of template", + "description": "The version of Template", "name": "version", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, + {}, { - "description": "the host ID for the router", - "name": "hostid", + "description": "The public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The Template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "True if the router Template requires upgrade", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", "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 id of the router", - "name": "id", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The name of the router", + "name": "name", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the name of VPC the router belongs to", + "description": "The name of VPC the router belongs to", "name": "vpcname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "The hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "Role of the domain router", + "name": "role", "type": "string" }, { - "description": "the list of nics associated with the router", + "description": "The list of NICs associated with the router", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the nic", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the isolation uri of the nic", + "description": "The isolation URI of the NIC", "name": "isolationuri", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "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 gateway of the nic", - "name": "gateway", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The Network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the public netmask for the router", + "description": "The public netmask for the router", "name": "publicnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the router", + "name": "id", + "type": "string" }, - {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if any health checks had failed", + "description": "True if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, + {}, { - "description": "the domain ID associated with the router", - "name": "domainid", + "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 domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "The public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "The project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "The version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "The first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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": "The result of the health check if available", + "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 date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "The name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "The Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "The host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "The guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "The project id of the IP address", + "name": "projectid", + "type": "string" + }, + { + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -134248,17 +134320,16 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -134268,11 +134339,12 @@ "type": "string" }, { - "description": "", + "description": "The Physical Network ID", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "Cisco VNMC resource ID", @@ -134285,6 +134357,11 @@ ], "related": "", "response": [ + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, {}, {}, @@ -134292,16 +134369,11 @@ {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -134309,6 +134381,13 @@ "isasync": true, "name": "executeClusterDrsPlan", "params": [ + { + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" + }, { "description": "ID of cluster", "length": 255, @@ -134316,23 +134395,10 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" - }, - { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" } ], "related": "", "response": [ - {}, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, { "description": "Start event Id of the DRS Plan", "name": "eventid", @@ -134343,17 +134409,7 @@ "name": "status", "type": "status" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Type of DRS Plan (Automated or Manual))", "name": "type", @@ -134364,11 +134420,27 @@ "name": "id", "type": "string" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "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": "List of migrations", + "name": "migrations", + "type": "list" + }, {} ], "since": "4.19.0" @@ -134388,27 +134460,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", + "description": "The UUID of the latest async job acting on 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", + "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" @@ -134419,47 +134491,47 @@ "name": "uploadResourceIcon", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, + "type": "string" + }, + { + "description": "List of resources to upload the icon/image for", "length": 255, "name": "resourceids", "required": true, "type": "list" }, { - "description": "type of the resource", + "description": "Type of the resource", "length": 255, "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, - "type": "string" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "True 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -134472,112 +134544,117 @@ "name": "updateKubernetesSupportedVersion", "params": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", + "description": "The ID of the Kubernetes supported version", "length": 255, - "name": "state", + "name": "id", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Kubernetes supported version", + "description": "The enabled or disabled state of the Kubernetes supported version", "length": 255, - "name": "id", - "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "name": "state", "required": true, - "type": "uuid" + "type": "string" } ], "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "response": [ { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "The name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "The minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + {}, + { + "description": "Whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", + "description": "The date when this Kubernetes supported version was created", "name": "created", "type": "date" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "The 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 name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the URL of the binaries ISO for Kubernetes supported version", + "name": "isourl", "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "The ID of the Kubernetes supported version", + "name": "id", "type": "string" }, - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "The ID of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "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 state of the binaries ISO for Kubernetes supported version", + "description": "The state of the binaries ISO for Kubernetes supported version", "name": "isostate", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "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", + "description": "The minimum RAM size in MB needed for the Kubernetes supported version", "name": "minmemory", "type": "integer" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", + "description": "The ID of the zone in which Kubernetes supported version is available", "name": "zoneid", "type": "string" } @@ -134599,24 +134676,24 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", + "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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -134647,51 +134724,51 @@ "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, - { - "description": "id of zone to which the IPv6 prefix belongs to.", + "description": "ID of zone to which the IPv6 prefix belongs to.", "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "guest IPv6 prefix", + "description": "Guest IPv6 prefix", "name": "prefix", "type": "string" }, { - "description": "id of the guest IPv6 prefix", + "description": "Date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "ID of the guest IPv6 prefix", "name": "id", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "description": "Count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "type": "integer" }, { - "description": "count of the total IPv6 subnets for the prefix.", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0.0" @@ -134701,20 +134778,6 @@ "isasync": false, "name": "createRole", "params": [ - { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "Creates a role with this unique name", "length": 255, @@ -134730,61 +134793,75 @@ "required": false, "type": "uuid" }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { "description": "The description of the role", "length": 255, "name": "description", "required": false, "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" } ], "related": "listRoles,updateRole", "response": [ { - "description": "the ID of the role", + "description": "The ID of the role", "name": "id", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "The name of the role", + "name": "name", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the state of the role", + "name": "state", + "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the state of the role", - "name": "state", + "description": "The type of the role", + "name": "type", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "True if role is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the description of the role", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -134796,42 +134873,42 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Upload volume/template/iso 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", + "name": "diskofferingid", "related": "", "required": false, "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "The name of the Volume/Template/ISO", "length": 255, - "name": "format", + "name": "name", "required": true, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the ID of the zone the volume/template/iso 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": "listZones", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, + { + "description": "An optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Image store uuid", "length": 255, @@ -134840,65 +134917,65 @@ "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, "name": "checksum", "required": false, "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "description": "Upload Volume/Template/ISO for the project", "length": 255, - "name": "diskofferingid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "The ID of the zone the Volume/Template/ISO is to be hosted on", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, + {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "The Template/volume ID", + "name": "id", + "type": "uuid" }, + {}, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "Encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "Signature to be sent in the POST request.", + "name": "signature", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -134906,12 +134983,12 @@ "since": "4.6.0" }, { - "description": "Updates an existing autoscale vm profile.", + "description": "Updates an existing autoscale Instance profile.", "isasync": true, "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the service offering of the auto deployed virtual machine", + "description": "The service offering of the auto deployed Instance", "length": 255, "name": "serviceofferingid", "related": "updateServiceOffering,listServiceOfferings", @@ -134920,15 +134997,15 @@ "type": "uuid" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the autoscale vm profile", + "description": "The ID of the autoscale Instance profile", "length": 255, "name": "id", "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", @@ -134936,46 +135013,55 @@ "type": "uuid" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "The ID of the user used to launch and destroy the Instances", "length": 255, - "name": "otherdeployparams", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, "since": "4.18.0", - "type": "map" + "type": "string" }, { - "description": "the template of the auto deployed virtual machine", + "description": "The time allowed for existing connections to get closed before an Instance is destroyed", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "expungevmgraceperiod", "required": false, - "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": "The Template of the auto deployed Instance", "length": 255, - "name": "customid", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", "length": 255, - "name": "expungevmgraceperiod", + "name": "otherdeployparams", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "map" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the userdata", "length": 255, - "name": "userdatadetails", + "name": "userdataid", + "related": "", "required": false, "since": "4.18.1", - "type": "map" + "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "An optional field, whether to the display the profile to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -134983,21 +135069,12 @@ "type": "boolean" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the ID of the userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatadetails", "required": false, "since": "4.18.1", - "type": "uuid" + "type": "map" }, { "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", @@ -135010,34 +135087,38 @@ "related": "listAutoScaleVmProfiles", "response": [ { - "description": "the project id vm profile", + "description": "The project id Instance profile", "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "The project name of the Instance profile", + "name": "project", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "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": "Base64 encoded VM user data", - "name": "userdata", + "description": "The autoscale Instance profile ID", + "name": "id", "type": "string" }, { @@ -135046,87 +135127,83 @@ "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "Base64 encoded Instance user data", + "name": "userdata", "type": "string" }, + {}, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance", + "name": "otherdeployparams", + "type": "map" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" }, {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "The service offering to be used while deploying an Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "The time allowed for existing connections to get closed before an Instance is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, - {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "The domain name of the Instance profile", + "name": "domain", "type": "string" }, {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "The availability zone to be used while deploying an Instance", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the User used to launch and destroy the Instances", + "name": "autoscaleuserid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The domain ID of the Instance profile", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "The Template to be used while deploying an Instance", + "name": "templateid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] }, { - "description": "Enables an AutoScale Vm Group", + "description": "Enables an AutoScale Instance Group", "isasync": true, "name": "enableAutoScaleVmGroup", "params": [ { - "description": "the ID of the autoscale group", + "description": "The ID of the autoscale group", "length": 255, "name": "id", "related": "enableAutoScaleVmGroup", @@ -135136,151 +135213,151 @@ ], "related": "", "response": [ + {}, { - "description": "the public ip address id", - "name": "publicipid", - "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", + "description": "The id of the guest Network the LB rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The domain ID of the Instance group", + "name": "domainid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "The autoscale Instance group ID", + "name": "id", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the private port", - "name": "privateport", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "Is group for display to the regular User", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "The name of the guest Network the LB rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the project name of the vm group", + "description": "The project name of the Instance group", "name": "project", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", - "type": "string" + "description": "List of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "The public IP address ID", + "name": "publicipid", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "The project id of the Instance group", + "name": "projectid", + "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "The name of the autoscale Instance group ", + "name": "name", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "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 autoscale profile that contains information about the Instances in the Instance group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "The public port", + "name": "publicport", + "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "The Account owning the Instance group", + "name": "account", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "description": "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", "name": "availablevirtualmachinecount", "type": "int" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "The current state of the AutoScale Instance Group", + "name": "state", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "List of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The date when this Instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "The frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "true if the entity/resource has annotations", + "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 minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "The domain name of the Instance group", + "name": "domain", "type": "string" }, + {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "The private port", + "name": "privateport", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "The LB provider of the guest Network the LB rule belongs to", + "name": "lbprovider", "type": "string" } ] @@ -135290,17 +135367,10 @@ "isasync": false, "name": "listGuestNetworkIpv6Prefixes", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -135313,67 +135383,74 @@ "type": "uuid" }, { - "description": "UUID of the IPv6 prefix.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "UUID of the IPv6 prefix.", + "length": 255, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of the guest IPv6 prefix", + "name": "id", + "type": "string" }, { - "description": "count of the used IPv6 subnets for the prefix.", + "description": "Count of the used IPv6 subnets for the prefix.", "name": "usedsubnets", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest IPv6 prefix", + "name": "prefix", "type": "string" }, - {}, { - "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" }, - {}, { - "description": "count of the total IPv6 subnets for the prefix.", + "description": "Count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", + "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.", + "description": "Count of the available IPv6 subnets for the prefix.", "name": "availablesubnets", "type": "integer" } @@ -135385,13 +135462,6 @@ "isasync": true, "name": "updateGuestOsMapping", "params": [ - { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, - "type": "string" - }, { "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", "length": 255, @@ -135400,6 +135470,13 @@ "since": "4.19.0", "type": "boolean" }, + { + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + }, { "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, @@ -135412,99 +135489,99 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The hypervisor", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "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": "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": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "Standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "Hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, {}, { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "Version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "is the mapping user defined", + "description": "Is the mapping user defined", "name": "isuserdefined", "type": "string" }, - {} + { + "description": "The ID of the Guest OS mapping", + "name": "id", + "type": "string" + } ], "since": "4.4.0" }, { - "description": "delete Tungsten-Fabric tag", + "description": "Delete Tungsten-Fabric tag", "isasync": true, "name": "deleteTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric tag", + "description": "The ID of zone", "length": 255, - "name": "taguuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "The uuid of Tungsten-Fabric tag", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "taguuid", "required": true, - "type": "uuid" + "type": "string" } ], "response": [ + {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "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" + } ] }, { @@ -135513,101 +135590,94 @@ "name": "updateHostPassword", "params": [ { - "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 new password for the host/cluster", "length": 255, "name": "password", "required": true, "type": "string" }, { - "description": "the host ID", + "description": "The cluster ID", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "if the password should also be updated on the hosts", + "description": "If the password should also be updated on the hosts", "length": 255, "name": "update_passwd_on_host", "required": false, "type": "boolean" }, { - "description": "the username for the host/cluster", + "description": "The username for the host/cluster", "length": 255, "name": "username", "required": true, "type": "string" + }, + { + "description": "The host ID", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { - "description": "adds a range of portable public IP's to a region", + "description": "Adds a range of portable public IP's to a region", "isasync": true, "name": "createPortableIpRange", "params": [ { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "The netmask of the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the beginning IP address in the portable IP range", + "description": "The beginning IP address in the portable IP range", "length": 255, "name": "startip", "required": true, "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "The ending IP address in the portable IP range", "length": 255, "name": "endip", "required": true, "type": "string" }, - { - "description": "the gateway for the portable IP range", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" - }, { "description": "Id of the Region", "length": 255, @@ -135617,116 +135687,123 @@ "type": "integer" }, { - "description": "the netmask of the portable IP range", + "description": "The gateway for the portable IP range", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" + }, + { + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "The ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, + { + "description": "The gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "The start IP of the portable IP range", + "name": "startip", + "type": "string" + }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "The domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", + "description": "The physical Network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", - "type": "string" + "description": "Date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "The ID of the Network where IP belongs to", + "name": "networkid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "The Account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "public IP address", + "description": "Region ID in which global Load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "Public IP address", "name": "ipaddress", "type": "string" }, { - "description": "VPC the ip belongs to", + "description": "VPC the IP belongs to", "name": "vpcid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "The ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" - }, - { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" } ], "type": "list" }, - {}, - { - "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 VLAN IP range", "name": "netmask", "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 start ip of the portable IP range", - "name": "startip", + "description": "The end IP of the portable IP range", + "name": "endip", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "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", + "description": "Region ID in which portable IP range is provisioned", "name": "regionid", "type": "integer" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "The 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", + "description": "Portable IP range ID", + "name": "id", "type": "string" }, {} @@ -135738,6 +135815,14 @@ "isasync": false, "name": "deleteWebhookDelivery", "params": [ + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be considered.", "length": 255, @@ -135760,14 +135845,6 @@ "required": false, "type": "date" }, - { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "The ID of the Webhook", "length": 255, @@ -135778,830 +135855,853 @@ } ], "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", + "description": "True 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.20.0" }, { - "description": "Updates an existing cluster", + "description": "Lists the VMs in a VMware Datacenter", "isasync": false, - "name": "updateCluster", + "name": "listVmwareDcVms", "params": [ { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "", "length": 255, - "name": "arch", + "name": "pagesize", "required": false, - "since": "4.20", - "type": "string" + "type": "integer" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "Name of the host on vCenter. Must be set along with the instancename parameter", "length": 255, - "name": "allocationstate", + "name": "hostname", "required": false, "type": "string" }, { - "description": "the ID of the Cluster", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, + "name": "existingvcenterid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "the cluster name", + "description": "The password for specified username.", "length": 255, - "name": "clustername", + "name": "password", "required": false, "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "The Username required to connect to resource.", "length": 255, - "name": "managedstate", + "name": "username", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster", + "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", "length": 255, - "name": "clustertype", + "name": "instancename", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", + "description": "List by keyword", "length": 255, - "name": "externaldetails", + "name": "keyword", "required": false, - "since": "4.21.0", - "type": "map" - } - ], - "related": "addCluster", - "response": [ - {}, - { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", - "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 name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, "type": "string" - }, + } + ], + "related": "listUnmanagedInstances", + "response": [ { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The hypervisor version of the host to which Instance belongs", + "name": "hypervisorversion", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "The list of NICs associated with the Instance", + "name": "nic", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "The ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the capacity type", + "description": "The type of the NIC", "name": "type", - "type": "short" + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "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 gateway of the NIC", + "name": "gateway", "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "The isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], - "type": "list" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "type": "set" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "The operating system of the Instance", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The ID of the cluster to which Instance belongs", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "The CPU speed of the Instance", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the cluster ID", - "name": "id", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" - }, - {}, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "The operating system ID of the Instance", + "name": "osid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Update the extension", - "isasync": false, - "name": "updateExtension", - "params": [ - { - "description": "State of the extension", - "length": 255, - "name": "state", - "required": false, + "description": "The hypervisor to which Instance belongs", + "name": "hypervisor", "type": "string" }, { - "description": "Description of the extension", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", - "length": 255, - "name": "orchestratorrequirespreparevm", - "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 extension, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "The ID of the extension", - "length": 255, - "name": "id", - "related": "listExtensions,updateExtension", - "required": true, - "type": "uuid" - } - ], - "related": "listExtensions", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, - { - "description": "ID of the extension", - "name": "id", - "type": "string" - }, - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - { - "description": "The state of the extension", - "name": "state", - "type": "string" - }, - {}, - { - "description": "Type of the extension", - "name": "type", - "type": "string" - }, - { - "description": "List of resources to which extension is registered to", - "name": "resources", + "description": "The list of disks associated with the Instance", + "name": "disk", "response": [ { - "description": "Type of the resource", - "name": "type", + "description": "The file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "Name of the resource associated with this mapping", - "name": "name", + "description": "The controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the details of the resource map", - "name": "details", - "type": "map" + "description": "The capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "ID of the resource associated with the extension", + "description": "The controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "The label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "The position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "The controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "The controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "The ID of the disk", "name": "id", "type": "string" }, { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" + "description": "The controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "The controller of the disk", + "name": "datastorehost", + "type": "string" } ], - "type": "list" + "type": "set" }, {}, + {}, { - "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 name of the host to which Instance belongs", + "name": "hostname", "type": "string" }, { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" + "description": "The ID of the host to which Instance belongs", + "name": "hostid", + "type": "string" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" + "description": "The CPU cores of the Instance", + "name": "cpunumber", + "type": "integer" }, { - "description": "Name of the extension", - "name": "name", + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" }, { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" + "description": "The CPU cores per socket for the Instance. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, - {}, { - "description": "Description of the extension", - "name": "description", + "description": "The memory of the Instance in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "The power state of the Instance", + "name": "powerstate", "type": "string" } - ], - "since": "4.21.0" + ] }, { - "description": "Lists the VMs in a VMware Datacenter", + "description": "Updates an existing cluster", "isasync": false, - "name": "listVmwareDcVms", + "name": "updateCluster", "params": [ { - "description": "UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The Username required to connect to resource.", + "description": "Hypervisor type of the cluster", "length": 255, - "name": "username", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "", + "description": "The ID of the Cluster", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "Hypervisor type of the cluster", "length": 255, - "name": "vcenter", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "Name of the host on vCenter. Must be set along with the instancename parameter", + "description": "The cluster name", "length": 255, - "name": "hostname", + "name": "clustername", "required": false, "type": "string" }, { - "description": "The password for specified username.", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "password", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", "length": 255, - "name": "instancename", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "Name of VMware datacenter.", + "description": "Whether this cluster is managed by cloudstack", "length": 255, - "name": "datacentername", + "name": "managedstate", "required": false, "type": "string" } ], - "related": "listUnmanagedInstances", + "related": "addCluster", "response": [ { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "indicates the boot mode", - "name": "bootmode", - "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", + "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", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "The hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "The Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "The type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "indicates the boot type", - "name": "boottype", + "description": "Whether this cluster is managed by Cloudstack", + "name": "managedstate", "type": "string" }, + {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "The capacity of the Cluster", + "name": "capacity", "response": [ { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "The Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "The capacity name", + "name": "name", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", - "type": "string" + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the label of the disk", - "name": "label", + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "The total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "The Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "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 virtual machine", - "name": "nic", + "description": "The Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "The CPU overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + {}, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "The cluster name", + "name": "name", + "type": "string" + }, + { + "description": "The cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "The Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "The Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + {} + ] + }, + { + "description": "Update the extension", + "isasync": false, + "name": "updateExtension", + "params": [ + { + "description": "Description of the extension", + "length": 255, + "name": "description", + "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 extension, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "The ID of the extension", + "length": 255, + "name": "id", + "related": "listExtensions,updateExtension", + "required": true, + "type": "uuid" + }, + { + "description": "State of the extension", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "length": 255, + "name": "reservedresourcedetails", + "required": false, + "since": "4.22.1", + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "length": 255, + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" + } + ], + "related": "listExtensions", + "response": [ + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + {}, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Name of the resource associated with this mapping", + "name": "name", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" }, { - "description": "the ID of the nic", + "description": "ID of the resource associated with the extension", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the details of the resource map", + "name": "details", + "type": "map" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of the resource", + "name": "type", "type": "string" } ], - "type": "set" + "type": "list" }, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "The state of the extension", + "name": "state", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "Description of the extension", + "name": "description", "type": "string" }, - {}, - {}, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + { + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" } - ] + ], + "since": "4.21.0" }, { "description": "Lists storage providers.", @@ -136630,7 +136730,7 @@ "type": "string" }, { - "description": "the type of storage provider: either primary or image", + "description": "The type of storage provider: either primary or image", "length": 255, "name": "type", "required": true, @@ -136640,27 +136740,27 @@ "related": "", "response": [ { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "The name of the storage provider", + "name": "name", "type": "string" }, - {}, { - "description": "the name of the storage provider", - "name": "name", + "description": "The type of the storage provider: primary or image provider", + "name": "type", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -136669,12 +136769,11 @@ "name": "listUcsProfiles", "params": [ { - "description": "the id for the ucs manager", + "description": "", "length": 255, - "name": "ucsmanagerid", - "related": "", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -136686,34 +136785,35 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "The ID for the ucs manager", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "ucs profile dn", + "description": "UCS profile dn", "name": "ucsdn", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -136736,63 +136836,63 @@ "related": "", "response": [ { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether API key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" }, {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "description": "The secret key of the registered user", + "name": "secretkey", + "type": "string" + }, + {}, + { + "description": "The API key of the registered user", "name": "apikey", "type": "string" }, { - "description": "whether api key access is allowed or not", - "name": "apikeyaccess", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.10.0" }, { - "description": "update global load balancer rules.", + "description": "Update global load balancer rules.", "isasync": true, "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "Session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "Load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "the description of the load balancer rule", + "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", + "description": "The ID of the global load balancer rule", "length": 255, "name": "id", "related": "updateGlobalLoadBalancerRule", @@ -136803,322 +136903,275 @@ "related": "", "response": [ { - "description": "Region Id in which global load balancer is created", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Session persistence method used for the global Load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, + { + "description": "Region ID in which global Load balancer is created", "name": "regionid", "type": "integer" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "The project ID of the Load balancer", + "name": "projectid", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "Global Load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "The project name of the Load balancer", + "name": "project", "type": "string" }, + {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "Name of the global Load balancer rule", + "name": "name", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "DNS domain name given for the global Load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "The domain ID of the Load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "The description of the global Load balancer rule", + "name": "description", "type": "string" }, + {}, { - "description": "global load balancer rule ID", - "name": "id", + "description": "Load balancing method used for the global Load balancer", + "name": "gslblbmethod", "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": "List of load balancer rules that are part of GSLB rule", + "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 load balancer rule ID", + "description": "The project name of the Load balancer", + "name": "project", + "type": "string" + }, + { + "description": "The public IP address ID", + "name": "publicipid", + "type": "string" + }, + { + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "The public port", + "name": "publicport", + "type": "string" + }, + { + "description": "The Load balancer rule ID", "name": "id", "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 CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "The domain of the Load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "The private port", + "name": "privateport", + "type": "string" + }, { "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "The public IP address", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The Account of the Load balancer rule", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "The project ID of the Load balancer", + "name": "projectid", "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 list of resource tags associated with load balancer", + "description": "The list of resource tags associated with Load balancer", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "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": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the rule", + "description": "The state of the rule", "name": "state", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The description of the Load balancer", + "name": "description", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "The protocol of the Load Balancer rule", + "name": "protocol", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "The name of the Load balancer", + "name": "name", "type": "string" }, { - "description": "the id of the zone the rule belongs to", + "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 name of the load balancer", - "name": "name", + "description": "The ID of the guest Network the LB rule belongs to", + "name": "networkid", "type": "string" } ], "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 rule", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "The 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": "GSLB service type", + "name": "gslbservicetype", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ] }, { - "description": "Allow or disallow a user to use SAML SSO", + "description": "Lists host tags", "isasync": false, - "name": "authorizeSamlSso", + "name": "listHostTags", "params": [ { - "description": "The Identity Provider ID the user is allowed to get single signed on from", + "description": "List by keyword", "length": 255, - "name": "entityid", - "related": "listIdps", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", - "required": true, - "type": "uuid" - }, - { - "description": "If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.", - "length": 255, - "name": "enable", - "required": true, - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists host tags", - "isasync": false, - "name": "listHostTags", - "params": [ { "description": "", "length": 255, @@ -137132,48 +137185,41 @@ "name": "pagesize", "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 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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the ID of the host tag", - "name": "id", - "type": "string" + "description": "true if the host tag is implicit", + "name": "isimplicit", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the host tag", + "name": "name", "type": "string" }, + {}, { - "description": "true if the host tag is implicit", - "name": "isimplicit", - "type": "boolean" + "description": "The host ID of the host tag", + "name": "hostid", + "type": "long" } ] }, @@ -137190,18 +137236,25 @@ "type": "string" }, { - "description": "Optional name for Guest OS", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "name", + "name": "forDisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "whether this guest OS is available for end users", + "description": "Map of (key/value pairs)", "length": 255, - "name": "forDisplay", + "name": "details", "required": false, - "type": "boolean" + "type": "map" + }, + { + "description": "Optional name for Guest OS", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "ID of Guest OS category", @@ -137210,204 +137263,161 @@ "related": "listOsCategories", "required": true, "type": "uuid" - }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "", "response": [ { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" + "description": "Is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the OS type", + "description": "The name of the OS type", "name": "name", "type": "string" }, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, {}, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "The ID of the OS category", + "name": "oscategoryid", + "type": "string" }, { - "description": "the name/description of the OS type", + "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": "The name of the OS category", + "name": "oscategoryname", + "type": "string" }, { - "description": "the ID of the OS type", + "description": "The ID of the OS type", "name": "id", "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" } ], "since": "4.4.0" }, { - "description": "add an annotation.", + "description": "Add an annotation.", "isasync": false, "name": "addAnnotation", "params": [ { - "description": "the annotation is visible for admins only", + "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", "length": 255, - "name": "adminsonly", + "name": "entitytype", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "the annotation text", + "description": "The ID of the entity to annotate", "length": 255, - "name": "annotation", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the id of the entity to annotate", + "description": "The annotation text", "length": 255, - "name": "entityid", + "name": "annotation", "required": false, "type": "string" }, { - "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", + "description": "The annotation is visible for admins only", "length": 255, - "name": "entitytype", + "name": "adminsonly", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the contents of the annotation", + "description": "The contents of the annotation", "name": "annotation", "type": "string" }, + {}, { - "description": "the creation timestamp for this annotation", + "description": "The creation timestamp for this annotation", "name": "created", "type": "date" }, { - "description": "the (uu)id of the annotation", + "description": "The UUID of the annotation", "name": "id", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "The removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "The UUID of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, - {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "The username of the User that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the type of the annotated entity", + "description": "The type of the annotated entity", "name": "entitytype", "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 UUID of the User that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - } - ], - "since": "4.11" - }, - { - "description": "Returns list of discovered SAML Identity Providers", - "isasync": false, - "name": "listIdps", - "params": [], - "related": "", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "The IdP Entity ID", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "The IdP Organization URL", - "name": "orgUrl", + "description": "The name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "The IdP Organization Name", - "name": "orgName", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" } - ] + ], + "since": "4.11" }, { "description": "Creates new NS Vpx", @@ -137415,15 +137425,15 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "the ID of the service offering for the virtual machine", + "description": "Availability zone for the Instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "The ID of the template for the Instance", "length": 255, "name": "templateid", "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", @@ -137431,42 +137441,37 @@ "type": "uuid" }, { - "description": "The network this ip address should be associated to.", + "description": "The ID of the service offering for the Instance", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, "type": "uuid" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "the public interface of the load balancer", + "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", + "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": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -137475,65 +137480,70 @@ "type": "list" }, { - "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", + "description": "Device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "True if device is dedicated for an account", + "name": "lbdevicededicated", "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": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "The physical Network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "Name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "Device name", + "name": "lbdevicename", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "Device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "The management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, {}, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "True if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "The private interface of the load balancer", + "name": "privateinterface", "type": "string" } ] @@ -137544,7 +137554,7 @@ "name": "listElastistorVolume", "params": [ { - "description": "the ID of the account", + "description": "The ID of the account", "length": 255, "name": "id", "required": true, @@ -137554,73 +137564,72 @@ "related": "", "response": [ { - "description": "compression", - "name": "compression", + "description": "The UUID of the latest async job acting on 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 volume", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Compression", + "name": "compression", "type": "string" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "The ID of the volume", + "name": "id", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "deduplication", + "description": "Deduplication", "name": "deduplication", "type": "string" }, { - "description": "synchronization", + "description": "Synchronization", "name": "sync", "type": "string" }, - { - "description": "the id of the volume", - "name": "id", - "type": "string" - }, {}, - {} + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "add a baremetal pxe server", + "description": "Add a baremetal PXE server", "isasync": true, "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "Tftp root directory of PXE server", + "description": "TFTP root directory of the PXE server", "length": 255, "name": "tftpdir", "required": true, "type": "string" }, { - "description": "Pod Id", + "description": "URL of the external pxe device", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "url", + "required": true, + "type": "string" }, { - "description": "URL of the external pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, @@ -137632,7 +137641,7 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -137640,14 +137649,15 @@ "type": "uuid" }, { - "description": "Credentials to reach external pxe device", + "description": "Pod Id", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "type of pxe device", + "description": "Type of pxe device", "length": 255, "name": "pxeservertype", "required": true, @@ -137656,11 +137666,6 @@ ], "related": "", "response": [ - { - "description": "url", - "name": "url", - "type": "string" - }, {}, { "description": "Tftp root directory of PXE server", @@ -137668,31 +137673,36 @@ "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", + "description": "URL", + "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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 to which this external DHCP device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "Name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "device id of ", + "description": "Device ID of ", "name": "id", "type": "string" }, - {} + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -137700,14 +137710,6 @@ "isasync": false, "name": "listNiciraNvpDevices", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -137736,59 +137738,67 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "The Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The physical Network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "This L2 gateway service UUID", + "name": "l2gatewayserviceuuid", "type": "string" }, - {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "This L3 gateway service UUID", + "name": "l3gatewayserviceuuid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, { - "description": "name of the provider", + "description": "Name of the provider", "name": "provider", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "Device name", + "name": "niciradevicename", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "The controller IP address", + "name": "hostname", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device id of the Nicire Nvp", + "description": "Device ID of the Nicire Nvp", "name": "nvpdeviceid", "type": "string" }, { - "description": "the transport zone Uuid", + "description": "The transport zone UUID", "name": "transportzoneuuid", "type": "string" } @@ -137800,29 +137810,29 @@ "name": "listAlerts", "params": [ { - "description": "the ID of the alert", + "description": "", "length": 255, - "name": "id", - "related": "listAlerts", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "The ID of the alert", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listAlerts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by alert type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list by alert name", + "description": "List by alert name", "length": 255, "name": "name", "required": false, @@ -137837,38 +137847,38 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "List by alert type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the alert", + "name": "description", "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 alert was sent", + "name": "sent", + "type": "date" }, { - "description": "the name of the alert", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the alert", + "description": "The ID of the alert", "name": "id", "type": "string" }, @@ -137877,81 +137887,80 @@ "name": "type", "type": "short" }, + {}, { - "description": "description of the alert", - "name": "description", + "description": "The name of the alert", + "name": "name", "type": "string" - }, - {} + } ] }, { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "description": "Creates and automatically starts an Instance based on a service offering, disk offering, and Template.", "isasync": true, "name": "deployVirtualMachine", "params": [ { - "description": "availability zone for the virtual machine", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "since": "4.19.0.0", + "type": "string" }, { - "description": "the ip address for default vm's network", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "ipaddress", + "name": "displayname", "required": false, "type": "string" }, { - "description": "the ID of the Userdata", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "userdataid", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.18", - "type": "uuid" + "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": "Destination Cluster ID to deploy the Instance to - parameter available for root admin only", "length": 255, - "name": "hypervisor", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", - "length": 255, - "name": "externaldetails", + "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.21.0", - "type": "map" + "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": "", + "name": "iptonetworklist", "required": false, - "since": "4.17", - "type": "uuid" + "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", + "description": "The ID of the Service offering for the Instance", "length": 255, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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": "size", + "name": "bootmode", "required": false, - "type": "long" + "since": "4.14.0.0", + "type": "string" }, { "description": "destination Host ID to deploy the VM to - parameter available for root admin only", @@ -137962,126 +137971,116 @@ "type": "uuid" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "affinitygroupnames", + "related": "", "required": false, "type": "list" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "displayvm", + "name": "startvm", "required": false, - "since": "4.2", "type": "boolean" }, { - "description": "", + "description": "the ID of the Userdata", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "userdataid", + "related": "", "required": false, - "since": "4.21", + "since": "4.18", "type": "uuid" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "iothreadsenabled", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "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": "securitygroupnames", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "name": "rootdisksize", "required": false, - "since": "4.12", - "type": "string" - }, - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "since": "4.4", + "type": "long" }, { - "description": "Controls specific policies on IO", + "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": "iodriverpolicy", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "Destination Pod ID to deploy the Instance to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "customid", + "name": "keypair", "required": false, "type": "string" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "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": "password", + "name": "datadiskofferinglist", "required": false, - "since": "4.19.0.0", - "type": "string" + "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": "used to specify the vApp properties.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "properties", "required": false, + "since": "4.15", "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "group", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "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": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", "length": 255, - "name": "datadiskofferinglist", + "name": "datadisksdetails", "required": false, - "since": "4.11", + "since": "4.21.0", "type": "map" }, { - "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": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "bootmode", + "name": "keypairs", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "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": "startvm", + "name": "overridediskofferingid", + "related": "", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { "description": "host name for the virtual machine", @@ -138091,26 +138090,33 @@ "type": "string" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "an optional group for the virtual machine", "length": 255, - "name": "rootdisksize", + "name": "group", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "description": "Enable packed virtqueues or not.", + "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": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "userdatadetails", "required": false, "since": "4.18", - "type": "boolean" + "type": "map" }, { - "description": "the ID of the template 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": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, @@ -138123,200 +138129,197 @@ "type": "integer" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "Deploy vm for the project", "length": 255, - "name": "keypair", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "", "length": 255, - "name": "boottype", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.21", + "type": "uuid" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "customid", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "Controls specific policies on IO", "length": 255, - "name": "nicmultiqueuenumber", + "name": "iodriverpolicy", "required": false, - "since": "4.18", - "type": "integer" + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "account", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "comma separated list of 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": "keyboard", + "name": "securitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.13", + "since": "4.21", "type": "uuid" }, { - "description": "used to specify the vApp properties.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "properties", + "name": "copyimagetags", "required": false, - "since": "4.15", - "type": "map" + "since": "4.13", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "dynamicscalingenabled", + "name": "ip6address", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "userdatadetails", + "name": "details", "required": false, - "since": "4.18", + "since": "4.3", "type": "map" }, { - "description": "Deploy vm for the project", + "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": "projectid", - "related": "", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "since": "4.15", + "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": "the mac address for default vm's network", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "macaddress", "required": false, - "type": "list" + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "keypairs", + "name": "iothreadsenabled", "required": false, - "since": "4.17", - "type": "list" + "type": "boolean" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "leaseexpiryaction", + "name": "dynamicscalingenabled", "required": false, - "since": "4.21.0", - "type": "string" + "since": "4.16", + "type": "boolean" }, { - "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "externaldetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.13", - "type": "boolean" + "type": "map" }, { - "description": "the mac address for default vm's network", + "description": "the ip address for default vm's network", "length": 255, - "name": "macaddress", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "details", + "name": "displayvm", "required": false, - "since": "4.3", - "type": "map" + "since": "4.2", + "type": "boolean" }, { - "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", + "description": "availability zone for the virtual machine", "length": 255, - "name": "datadisksdetails", - "required": false, - "since": "4.21.0", - "type": "map" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "The ID of the Template for the Instance", "length": 255, - "name": "iptonetworklist", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "", + "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": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "hypervisor", "required": false, - "since": "4.21", - "type": "uuid" + "type": "string" }, { - "description": "the ipv6 address for default vm's network", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", "length": 255, - "name": "ip6address", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional user generated name 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": "displayname", + "name": "securitygroupnames", + "related": "", "required": false, - "type": "string" + "type": "list" }, { "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", @@ -138327,133 +138330,169 @@ "type": "boolean" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "nicnetworklist", + "name": "deploymentplanner", "required": false, - "since": "4.15", - "type": "map" + "since": "4.4", + "type": "string" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "deploymentplanner", + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", "required": false, - "since": "4.4", "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the project name of the vm", - "name": "project", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The state of the Instance", + "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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { @@ -138462,134 +138501,134 @@ "type": "string" }, { - "description": "the date when this virtual machine was updated last time", + "description": "The date when this Instance was updated last time", "name": "lastupdated", "type": "date" }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, { "description": "the maximum Y resolution", "name": "maxresolutiony", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", + "description": "The list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", + "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", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", + "description": "Customer associated with the tag", "name": "customer", "type": "string" } @@ -138597,640 +138636,410 @@ "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "The starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", + "description": "The list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "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": "account owning the security group rule", + "description": "Account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", + "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 ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "The project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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 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", "type": "string" } ], "type": "set" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", + "description": "The name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "The ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", "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": "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": "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 Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "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", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "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 name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the 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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the 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": "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The project name where tag belongs to", + "name": "project", "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 corresponding network", - "name": "networkid", + "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 IPv6 address of network", - "name": "ip6address", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The ID of the Instance", + "name": "id", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" }, { "description": "NICs of the VNF appliance", @@ -139238,57 +139047,112 @@ "type": "list" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "The date when this Instance was created", + "name": "created", "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", + "description": "List of Affinity groups associated with the Instance", "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { @@ -139297,97 +139161,91 @@ "type": "list" }, { - "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 type of the affinity group", - "name": "type", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "Device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, - {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -139396,109 +139254,266 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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 isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The gateway of the NIC", + "name": "gateway", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "The ID of the host for the Instance", + "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 ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" } ] @@ -139509,130 +139524,123 @@ "name": "listVolumes", "params": [ { - "description": "List by keyword", + "description": "State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "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": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the ID of the availability zone", + "description": "List volumes by disk offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "The ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "displayvolume", "required": false, + "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": "declareHostAsDegraded,reconnectHost", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List volumes on specified host", "length": 255, - "name": "tags", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "isrecursive", "required": false, - "since": "4.3", - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "list only volumes that are encrypted", "length": 255, - "name": "name", + "name": "isencrypted", "required": false, - "type": "string" + "since": "4.19.1", + "type": "boolean" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "listsystemvms", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list volumes by disk offering", + "description": "The type of disk volume", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "type", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The name of the disk volume", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the disk volume", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, "name": "projectid", "related": "", @@ -139640,22 +139648,22 @@ "type": "uuid" }, { - "description": "the cluster id the disk volume belongs to", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the type of disk volume", + "description": "The ID of the disk volume", "length": 255, - "name": "type", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "The IDs of the volumes, mutually exclusive with id", "length": 255, "name": "ids", "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", @@ -139664,516 +139672,523 @@ "type": "list" }, { - "description": "", + "description": "The pod ID the disk volume belongs to", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isencrypted", + "name": "listall", "required": false, - "since": "4.19.1", "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "the pod id the disk volume belongs to", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "The ID of the Instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.19.1", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "The ID of the availability zone", "length": 255, - "name": "state", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "ID of the Instance", + "name": "virtualmachineid", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "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 Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance 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", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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": "shared or local storage", - "name": "storagetype", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "The state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "Size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + {}, + { + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "Min IOPS of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "The disk utilization", + "name": "utilization", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of the Instance", + "name": "vmtype", "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": "the project name of the vpn", - "name": "project", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Name of the Instance", + "name": "vmname", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "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 chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, + {}, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" + "description": "Cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", + "description": "The bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, - {}, - { - "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": "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": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the disk volume", + "name": "name", "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": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "True if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - } - ] - }, - { - "description": "Removes a Management Server.", - "isasync": false, - "name": "removeManagementServer", - "params": [ - { - "description": "the ID of the Management Server", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + } + ] + }, + { + "description": "Removes a Management Server.", + "isasync": false, + "name": "removeManagementServer", + "params": [ + { + "description": "the ID of the Management Server", + "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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" } ] }, @@ -140183,27 +140198,19 @@ "name": "createLBHealthCheckPolicy", "params": [ { - "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": "Number of consecutive health check success before declaring an Instance healthy", "length": 255, - "name": "intervaltime", + "name": "healthythreshold", "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": "HTTP ping path", "length": 255, @@ -140212,77 +140219,83 @@ "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": "Number of consecutive health check success before declaring an instance healthy", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "healthythreshold", + "name": "intervaltime", "required": false, "type": "integer" }, { - "description": "the description of the load balancer health check policy", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "description", + "name": "responsetimeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, "name": "lbruleid", "related": "", "required": true, "type": "uuid" + }, + { + "description": "The description of the load balancer health check policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, - { - "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 LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "The domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "the list of healthcheckpolicies", + "description": "The list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the state of the policy", + "description": "The pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "The state of the policy", "name": "state", "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "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 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 description of the healthcheck policy", + "name": "description", + "type": "string" }, { "description": "Amount of time between health checks", @@ -140290,48 +140303,50 @@ "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, { - "description": "the 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 description of the healthcheck policy", - "name": "description", - "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 Account of the HealthCheck policy", + "name": "account", + "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "The ID of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "The current status of the latest async job acting 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 of the HealthCheck policy", + "description": "The domain of the HealthCheck policy", "name": "domain", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -140360,13 +140375,34 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { @@ -140375,210 +140411,275 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "the list of resource tags associated", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 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": "the account associated with the tag", - "name": "account", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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" } ], "type": "set" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", + "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 traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The 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", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { @@ -140587,82 +140688,61 @@ "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", + "description": "Id of the Instance to which the NIC belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" } ], "type": "list" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - {}, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { @@ -140671,13 +140751,13 @@ "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -140686,43 +140766,13 @@ "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { @@ -140731,43 +140781,8 @@ "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { @@ -140776,23 +140791,23 @@ "type": "boolean" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" } ], @@ -140815,139 +140830,139 @@ "related": "disableUser,getUser,listUsers", "response": [ { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The user state", + "name": "state", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The Account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "The Account name of the user", + "name": "account", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "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 and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user name", + "description": "The user name", "name": "username", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The user lastname", + "name": "lastname", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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 API key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "The ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "The user email address", + "name": "email", + "type": "string" }, { - "description": "the timezone user was created in", + "description": "The timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "The user ID", + "name": "id", "type": "string" }, {}, { - "description": "the user state", - "name": "state", + "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", "type": "string" }, { - "description": "the account ID of the user", + "description": "The Account ID of the user", "name": "accountid", "type": "string" } @@ -140960,25 +140975,25 @@ "params": [], "related": "", "response": [ + {}, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the Cloudian Management Console base URL", - "name": "url", + "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 Cloudian Management Console base URL", + "name": "url", "type": "string" }, { - "description": "the Cloudian connector enabled state", + "description": "The Cloudian connector enabled state", "name": "enabled", "type": "boolean" } @@ -140986,157 +141001,162 @@ "since": "4.11.0" }, { - "description": "Creates a network", + "description": "Creates a Network", "isasync": false, "name": "createNetwork", "params": [ { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "The VPC network belongs to", "length": 255, - "name": "subdomainaccess", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "ip6cidr", + "name": "tungstenvirtualrouteruuid", "required": false, "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "When true bypasses VLAN ID/range overlap check during Network creation for shared and L2 Networks", "length": 255, - "name": "account", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "description": "The first IPv6 DNS for the network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ip6dns1", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the VPC network belongs to", + "description": "IPv4 address to be assigned to a router in a shared Network", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "routerip", "required": false, - "type": "uuid" + "since": "4.16", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "description": "The gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "tungstenvirtualrouteruuid", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the name of the network", + "description": "Network domain", "length": 255, - "name": "name", - "required": true, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the isolated private VLAN type for this network", + "description": "The ending IP address in the Network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "isolatedpvlantype", + "name": "endip", "required": false, "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "An optional field, whether to the display the network to the end User or not.", "length": 255, - "name": "gateway", + "name": "displaynetwork", + "required": false, + "type": "boolean" + }, + { + "description": "Account that will own the network. Account should be under the selected domain", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "The beginning IPv6 address in the IPv6 network range", "length": 255, "name": "startipv6", "required": false, "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "hideipaddressusage", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the zone ID for the network", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "The gateway of the Network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "netmask", + "name": "gateway", "required": false, "type": "string" }, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "The ending IPv6 address in the IPv6 network range", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "endipv6", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "the first IPv4 DNS for the network", + "description": "The isolated private VLAN for this Network", "length": 255, - "name": "dns1", + "name": "isolatedpvlan", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", "length": 255, - "name": "cidrsize", + "name": "sourcenatipaddress", "required": false, - "since": "4.20.0", - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "The ID or VID of the network", "length": 255, - "name": "endipv6", + "name": "vlan", "required": false, "type": "string" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "The beginning IP address in the Network IP range", "length": 255, - "name": "routeripv6", + "name": "startip", "required": false, - "since": "4.16", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "Domain ID of the account owning a network. If the Account is not specified, but the acltype is Account or not specified, the Network will be automatically assigned to the caller account and domain. To create a Network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If Account is not specified, but acltype is Domain, the network will be created for the specified domain.", "length": 255, - "name": "displaynetwork", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "The netmask of the Network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "sourcenatipaddress", + "name": "netmask", "required": false, - "since": "4.19", "type": "string" }, { @@ -141148,170 +141168,190 @@ "type": "integer" }, { - "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 physical Network ID the network belongs to", "length": 255, - "name": "acltype", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID or VID 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": "vlan", + "name": "acltype", "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": "ID of the network in an external system.", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "externalid", + "name": "cidrsize", "required": false, - "type": "string" + "since": "4.20.0", + "type": "integer" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "ID of the network in an external system.", "length": 255, - "name": "ip6gateway", + "name": "externalid", "required": false, "type": "string" }, { - "description": "the physical network ID the network belongs to", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "The display text of the network", "length": 255, - "name": "routerip", + "name": "displaytext", "required": false, - "since": "4.16", "type": "string" }, { - "description": "network domain", + "description": "The second IPv4 DNS for the network", "length": 255, - "name": "networkdomain", + "name": "dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Ids of the Bgp Peer for the network", + "description": "the AS Number of the network", "length": 255, - "name": "bgppeerids", - "related": "", + "name": "asnumber", "required": false, "since": "4.20.0", - "type": "list" + "type": "long" }, { - "description": "the beginning IP address in the network IP range", + "description": "An optional project for the network", "length": 255, - "name": "startip", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "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": "publicmtu", + "name": "subdomainaccess", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", + "description": "The zone ID for the network", "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the second IPv6 DNS for the network", + "description": "The name of the network", "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "name": "name", + "required": true, "type": "string" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "The first IPv4 DNS for the network", "length": 255, - "name": "endip", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the second IPv4 DNS for the network", + "description": "The CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "dns2", + "name": "ip6cidr", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the AS Number of the network", + "description": "The network offering ID", "length": 255, - "name": "asnumber", - "required": false, - "since": "4.20.0", - "type": "long" + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "When true IP address usage for the Network will not be exported by the listUsageRecords API", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "hideipaddressusage", "required": false, "type": "boolean" }, { - "description": "an optional project for the network", + "description": "The second IPv6 DNS for the network", "length": 255, - "name": "projectid", - "related": "", + "name": "ip6dns2", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "Network ACL ID associated for the network", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "the network offering ID", + "description": "IPv6 address to be assigned to a router in a shared Network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "routeripv6", + "required": false, + "since": "4.16", + "type": "string" }, { - "description": "the display text of the network", + "description": "IDs of the Bgp Peer for the Network", "length": 255, - "name": "displaytext", + "name": "bgppeerids", + "related": "", "required": false, - "type": "string" + "since": "4.20.0", + "type": "list" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "The ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "The details of the Network", + "name": "details", + "type": "map" + }, + { + "description": "The internet protocol of Network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "The first IPv4 DNS for the Network", + "name": "dns1", "type": "string" }, { @@ -141320,518 +141360,493 @@ "type": "resourceiconresponse" }, { - "description": "the list of services", + "description": "The displaytext of the Network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The Network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "The list of services", "name": "service", "response": [ { - "description": "the service provider name", + "description": "The service name", + "name": "name", + "type": "string" + }, + { + "description": "The service provider name", "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "services for this provider", + "description": "Services for this provider", "name": "servicelist", "type": "list" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "The provider name", + "name": "name", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "UUID of the Network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" }, { - "description": "the list of capabilities", + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", + "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 capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "The capability value", + "name": "value", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "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 network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "State of the Network", + "name": "state", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "The second IPv4 DNS for the Network", + "name": "dns2", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", "name": "vlan", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "VPC the network belongs to", + "description": "VPC the Network belongs to", "name": "vpcid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", + "description": "The total number of Network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "True if Network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The domain name of the Network owner", + "name": "domain", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, + {}, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "The date this Network was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "description": "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", "name": "reservediprange", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "The IPv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The Network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Related to what other Network configuration", + "name": "related", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", "type": "boolean" }, - {}, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", "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", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The list of resource tags associated with Network", + "name": "tags", + "response": [ + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "The type of the Network", + "name": "type", + "type": "string" }, { - "description": "acl type - access type to the network", + "description": "ACL type - access type to the Network", "name": "acltype", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "True if Network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The name of the zone the Network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The name of the Network", + "name": "name", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "True if Network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The ID of the Network", + "name": "id", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Zone ID of the Network", + "name": "zoneid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The domain ID of the Network owner", + "name": "domainid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", "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": "ip4routes", + "type": "set" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "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": "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": "the name of the network", - "name": "name", + "description": "The owner of the Network", + "name": "account", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "ACL name associated with the VPC Network", + "name": "aclname", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", "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": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - {}, - { - "description": "The external id of the network", - "name": "externalid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "List Networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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" } ] @@ -141842,425 +141857,425 @@ "name": "listNetworkOfferings", "params": [ { - "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 need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "List by keyword", "length": 255, - "name": "routingmode", + "name": "keyword", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "the availability of network offering. Default value is required", + "description": "List network offerings supporting certain services", "length": 255, - "name": "availability", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "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": "page", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "The network offering can be used only for network creation inside the VPC", + "length": 255, + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings by name", + "description": "True if offering has tags specified", "length": 255, - "name": "name", + "name": "istagged", "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 display text", "length": 255, - "name": "sourcenatsupported", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by state", + "description": "", "length": 255, - "name": "state", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List network offerings by tags", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "true if offering has tags specified", + "description": "List network offerings by ID", "length": 255, - "name": "istagged", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "True if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "isdefault", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "List network offerings by guest type: shared or isolated", "length": 255, "name": "guestiptype", "required": false, "type": "string" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "The availability of network offering. Default value is required", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "availability", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List network offerings available for network creation in specific zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network offerings supporting certain services", + "description": "True if need to list only default network offerings. Default value is false", "length": 255, - "name": "supportedservices", + "name": "isdefault", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "List network offerings by state", "length": 255, - "name": "specifyipranges", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "routingmode", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "list network offerings by display text", + "description": "List network offerings by name", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "", "length": 255, - "name": "forvpc", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list by traffic type", + "description": "List by traffic type", "length": 255, "name": "traffictype", "required": false, "type": "string" }, { - "description": "the tags for the network offering.", + "description": "The tags for the network offering.", "length": 255, "name": "specifyvlan", "required": false, "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list network offerings by ID", + "description": "List network offerings available for network creation in specific domain", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "domainid", + "related": "listDomains", "required": false, + "since": "4.13", "type": "uuid" } ], "related": "", "response": [ { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "An alternate display text of the Network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" + "description": "True if Network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "Availability of the Network offering", + "name": "availability", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "The traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.", + "name": "traffictype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "UUID of the Network provider", + "name": "id", + "type": "string" + }, + { + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "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" + } + ], + "type": "list" + }, + { + "description": "The list of capabilities", + "name": "capability", + "response": [ + { + "description": "The capability value", + "name": "value", + "type": "string" + }, + { + "description": "The capability name", + "name": "name", + "type": "string" + }, + { + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "The service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the ID of the service offering used by virtual router provider", + "description": "The ID of the service offering used by virtual router provider", "name": "serviceofferingid", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "The ID of the Network offering", + "name": "id", "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" + "description": "True if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "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": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "True if Network offering can be used by Tungsten-Fabric Networks only", + "name": "fortungsten", "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 date this Network offering was created", + "name": "created", + "type": "date" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "True if Network offering supports specifying IP ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "The tags for the Network offering", + "name": "tags", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" + "description": "Maximum number of concurrent connections to be handled by LB", + "name": "maxconnections", + "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "True if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, + {}, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "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 choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "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", - "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 NSX networks only", - "name": "fornsx", + "description": "True if Network offering can be used by VPC Networks only", + "name": "forvpc", "type": "boolean" }, - {}, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "The name of the Network offering", + "name": "name", + "type": "string" + }, { "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "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": "Additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "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 routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "The internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "True if Network offering supports VLANs, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the 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": "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": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" } ] }, @@ -142270,14 +142285,7 @@ "name": "listDedicatedPods", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the pod", + "description": "The ID of the pod", "length": 255, "name": "podid", "related": "createManagementNetworkIpRange", @@ -142285,12 +142293,11 @@ "type": "uuid" }, { - "description": "list dedicated pods by affinity group", + "description": "List by keyword", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -142299,6 +142306,14 @@ "required": false, "type": "integer" }, + { + "description": "The ID of the domain associated with the pod", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -142307,65 +142322,65 @@ "type": "integer" }, { - "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 domain associated with the pod", + "description": "The name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The domain ID to which the Pod is dedicated", + "name": "domainid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "The Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", + "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the Pod", + "description": "The ID of the Pod", "name": "podid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the pod", + "description": "The Dedication Affinity Group ID of the pod", "name": "affinitygroupid", "type": "string" }, - {}, - {}, - { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" - } + {} ] }, { @@ -142374,14 +142389,7 @@ "name": "listVPCs", "params": [ { - "description": "list VPC supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -142389,53 +142397,53 @@ "type": "uuid" }, { - "description": "flag to display the resource icon for VPCs", + "description": "List by display text of The VPC", "length": 255, - "name": "showicon", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "List by zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "List by display text of the VPC", + "description": "List VPCs by restartRequired option", "length": 255, - "name": "displaytext", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "List by name of the VPC", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list by ID of the VPC offering", + "description": "Flag to display the resource icon for VPCs", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by zone", + "description": "List by ID of the VPC offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, "type": "uuid" }, @@ -142447,95 +142455,121 @@ "type": "boolean" }, { - "description": "list VPC by id", + "description": "List by CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDR", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "cidr", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list VPCs by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "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": "list by name of the VPC", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "List VPCs by state", "length": 255, - "name": "cidr", + "name": "state", "required": false, "type": "string" }, { - "description": "list VPCs by restartRequired option", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "restartrequired", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List VPC by ID", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "page", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" + }, + { + "description": "List VPC supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "the name of the VPC", - "name": "name", + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "Zone ID of the VPC", + "name": "zoneid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "The first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, - {}, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "The project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "Is VPC for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "VPC offering ID the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { @@ -142543,75 +142577,166 @@ "name": "icon", "type": "resourceiconresponse" }, + {}, + { + "description": "True if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "The name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "If this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "The second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "The domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "The project ID of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The CIDR the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "The list of Networks belonging to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the list of supported services", + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" }, { - "description": "the service provider name", + "description": "The service provider name", "name": "provider", "response": [ { - "description": "the provider name", + "description": "The provider name", "name": "name", "type": "string" }, { - "description": "the destination physical network", + "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", + "description": "True if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "Services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "State of the Network provider", + "name": "state", "type": "string" }, { - "description": "uuid of the network provider", + "description": "UUID of the Network provider", "name": "id", "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" } ], "type": "list" }, { - "description": "the list of capabilities", + "description": "The list of capabilities", "name": "capability", "response": [ { - "description": "the capability name", + "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", + "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" @@ -142620,237 +142745,127 @@ "type": "list" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "The domain ID of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "The domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "The ID of the VPC", + "name": "id", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "An alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the owner of the VPC", + "description": "The owner of the VPC", "name": "account", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "The first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "State of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, {}, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "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 second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "True VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated with the project", + "description": "The list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", + "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": "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 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": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "description": "Does VPC use distributed router for one hop forwarding and host based Network ACL's", "name": "distributedvpcrouter", "type": "boolean" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "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": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" } ] }, @@ -142860,55 +142875,48 @@ "name": "addNetworkDevice", "params": [ { - "description": "parameters for network device", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "networkdeviceparameterlist", + "name": "networkdevicetype", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "Parameters for network device", "length": 255, - "name": "networkdevicetype", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" } ], "related": "", "response": [ { - "description": "the ID of the network device", + "description": "The ID of the Network device", "name": "id", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "description": "Execute network-utility command (ping/arping/tracert) on System VMs remotely", "isasync": true, "name": "runDiagnostics", "params": [ { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, - "type": "string" - }, - { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "The System VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, "name": "type", "required": true, @@ -142922,43 +142930,50 @@ "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", + "description": "The ID of the System VM to diagnose", "length": 255, "name": "targetid", "related": "startSystemVm", "required": true, "type": "uuid" + }, + { + "description": "Additional command line options that apply for each command", + "length": 255, + "name": "params", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "The command execution return code", + "name": "exitcode", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The standard error output from the command execution", "name": "stderr", "type": "string" }, { - "description": "the command execution return code", - "name": "exitcode", + "description": "The standard output from the command execution", + "name": "stdout", "type": "string" - }, - {} + } ], "since": "4.12.0.0" }, @@ -142968,15 +142983,14 @@ "name": "restartVPC", "params": [ { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "Should we cleanup the old Network elements", "length": 255, - "name": "livepatch", + "name": "cleanup", "required": false, - "since": "4.17.0", "type": "boolean" }, { - "description": "the id of the VPC", + "description": "The ID of the VPC", "length": 255, "name": "id", "related": "createVPC,listVPCs,updateVPC", @@ -142984,43 +142998,44 @@ "type": "uuid" }, { - "description": "If cleanup old network elements", + "description": "Turn a single VPC into a redundant one.", "length": 255, - "name": "cleanup", + "name": "makeredundant", "required": false, "type": "boolean" }, { - "description": "Turn a single VPC into a redundant one.", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "makeredundant", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - {} + } ] }, { @@ -143028,20 +143043,6 @@ "isasync": false, "name": "quotaConfigureEmail", "params": [ - { - "description": "If the quota email template should be enabled", - "length": 255, - "name": "enable", - "required": false, - "type": "boolean" - }, - { - "description": "New quota account min balance", - "length": 255, - "name": "minbalance", - "required": false, - "type": "double" - }, { "description": "Quota email template name which should be configured", "length": 255, @@ -143056,57 +143057,64 @@ "related": "enableAccount,listAccounts", "required": true, "type": "uuid" + }, + { + "description": "If the quota email template should be enabled", + "length": 255, + "name": "enable", + "required": false, + "type": "boolean" + }, + { + "description": "New quota account min balance", + "length": 255, + "name": "minbalance", + "required": false, + "type": "double" } ], "related": "", "response": [ { - "description": "The template's name.", - "name": "templatename", + "description": "The configured account's id.", + "name": "account", "type": "string" }, { - "description": "The configured account's id.", - "name": "account", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Whether the template is enabled.", "name": "enabled", "type": "boolean" }, + {}, { "description": "The configured account's min balance.", "name": "minbalance", "type": "double" }, + { + "description": "The template's name.", + "name": "templatename", + "type": "string" + }, {} ], "since": "4.20.0.0" }, { - "description": "adds a baremetal dhcp server", + "description": "Adds a baremetal DHCP server", "isasync": true, "name": "addBaremetalDhcp", "params": [ - { - "description": "Type of dhcp device", - "length": 255, - "name": "dhcpservertype", - "required": true, - "type": "string" - }, { "description": "Credentials to reach external dhcp device", "length": 255, @@ -143115,13 +143123,20 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", "required": true, "type": "uuid" }, + { + "description": "Credentials to reach external dhcp device", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "URL of the external dhcp appliance.", "length": 255, @@ -143130,9 +143145,9 @@ "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "Type of dhcp device", "length": 255, - "name": "username", + "name": "dhcpservertype", "required": true, "type": "string" } @@ -143140,88 +143155,88 @@ "related": "listBaremetalDhcp", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "URL", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", - "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": "dhcpservertype", + "description": "Name of the provider", + "name": "provider", "type": "string" }, {}, + {}, { - "description": "url", - "name": "url", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "Name of the provider", + "name": "dhcpservertype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Device ID of ", + "name": "id", + "type": "string" } ] }, { - "description": "delete Tungsten-Fabric application policy set", + "description": "Delete Tungsten-Fabric application policy set", "isasync": true, "name": "deleteTungstenFabricApplicationPolicySet", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "The ID of zone", "length": 255, - "name": "applicationpolicysetuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "The UUID of Tungsten-Fabric application policy set", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "applicationpolicysetuuid", "required": true, - "type": "uuid" + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "any text associated with the success or failure", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -143230,12 +143245,13 @@ "name": "copySnapshot", "params": [ { - "description": "The ID of the zone the snapshot is being copied to.", + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only", "length": 255, - "name": "destzoneid", - "related": "listZones", + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "list" }, { "description": "the ID of the snapshot.", @@ -143246,21 +143262,12 @@ "type": "uuid" }, { - "description": "This parameter enables the option the snapshot to be copied to supported primary storage", - "length": 255, - "name": "usestoragereplication", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only", + "description": "The ID of the zone the snapshot is being copied to.", "length": 255, - "name": "storageids", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "destzoneid", + "related": "listZones", "required": false, - "since": "4.21.0", - "type": "list" + "type": "uuid" }, { "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", @@ -143270,6 +143277,14 @@ "required": false, "type": "uuid" }, + { + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "length": 255, + "name": "usestoragereplication", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, { "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, @@ -143282,94 +143297,166 @@ "related": "listSnapshots", "response": [ { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "Indicates whether the underlying storage supports reverting the volume to this Snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "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 list of resource tags associated", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "ID of the snapshot", + "description": "ID of the Snapshot", "name": "id", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "The project name of the Snapshot", + "name": "project", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The parent name of the Snapshot", + "name": "parentname", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "The date the Snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the snapshot", + "description": "The Account associated with the Snapshot", "name": "account", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "Physical size of backed up Snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "Name of the Snapshot", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", - "type": "long" + "description": "Display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { "description": "ID of the disk volume", @@ -143378,141 +143465,79 @@ }, {}, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "The domain ID of the Snapshot's Account", + "name": "domainid", + "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" }, + {}, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "The project id of the Snapshot", + "name": "projectid", "type": "string" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "Virtual size of backedup Snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "The domain name of the Snapshot's Account", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "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": "id of the os on volume", - "name": "ostypeid", + "description": "Name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The parent ID of the Snapshot", + "name": "parent", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "The type of the Snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "Valid types are hourly, daily, weekly, monthy, Template, and none.", + "name": "intervaltype", "type": "string" } ], @@ -143530,6 +143555,13 @@ "required": false, "type": "string" }, + { + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, + "type": "string" + }, { "description": "Zone in which to add the external firewall appliance.", "length": 255, @@ -143538,13 +143570,6 @@ "required": true, "type": "uuid" }, - { - "description": "Traffic going into the listed zones will be metered", - "length": 255, - "name": "includezones", - "required": false, - "type": "string" - }, { "description": "URL of the traffic monitor Host", "length": 255, @@ -143556,39 +143581,39 @@ "related": "", "response": [ { - "description": "the ID of the external firewall", - "name": "id", - "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 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 current status of the latest async job acting on this object", + "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", + "description": "The zone ID of the external firewall", "name": "zoneid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The 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", "type": "string" }, {}, { - "description": "the management IP address of the external firewall", + "description": "The management IP address of the external firewall", "name": "ipaddress", "type": "string" } @@ -143600,9 +143625,9 @@ "name": "listUsers", "params": [ { - "description": "List by keyword", + "description": "List user by the username", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" }, @@ -143615,14 +143640,14 @@ "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 resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, @@ -143636,6 +143661,21 @@ "since": "4.21.0.0", "type": "string" }, + { + "description": "List only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" + }, { "description": "List users by the Api key access value", "length": 255, @@ -143645,11 +143685,11 @@ "type": "string" }, { - "description": "", + "description": "List users by state of the user account.", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -143659,45 +143699,30 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "flag to display the resource icon for users", + "description": "Flag to display the resource icon for users", "length": 255, "name": "showicon", "required": false, "type": "boolean" }, { - "description": "List users by state of the user account.", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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 users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "List user by the username", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" } @@ -143705,141 +143730,141 @@ "related": "disableUser,getUser", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "The user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "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 timezone user was created in", + "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 name of the role", + "name": "rolename", + "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "The domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "The secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", + "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 Account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the user email address", - "name": "email", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "The domain name of the user", + "name": "domain", "type": "string" }, { - "description": "true if user is default, false otherwise", + "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 ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user ID", + "name": "id", + "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 API key of the user", + "name": "apikey", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "The user email address", + "name": "email", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ] }, @@ -143849,71 +143874,71 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the gateway of the VLAN IP range", + "description": "The beginning IPv6 address in the IPv6 Network range", "length": 255, - "name": "gateway", + "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 UUID of the VLAN IP range", "length": 255, - "name": "startipv6", - "required": false, - "type": "string" + "name": "id", + "related": "updateVlanIpRange", + "required": true, + "type": "uuid" }, { - "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" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "The CIDR of IPv6 Network, must be at least /64", "length": 255, - "name": "forsystemvms", + "name": "ip6cidr", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the UUID of the VLAN IP range", + "description": "The netmask of the VLAN IP range", "length": 255, - "name": "id", - "related": "updateVlanIpRange", - "required": true, - "type": "uuid" + "name": "netmask", + "required": false, + "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "The gateway of the VLAN IP range", "length": 255, - "name": "ip6cidr", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "True if IP range is set to System VM, false if not", "length": 255, - "name": "endipv6", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "The gateway of the IPv6 Network", "length": 255, - "name": "startip", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "The ending IP address in the VLAN IP range", "length": 255, "name": "endip", "required": false, @@ -143923,147 +143948,147 @@ "related": "", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The ID or VID of the VLAN.", + "name": "vlan", "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 gateway of IPv6 network", - "name": "ip6gateway", + "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 ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "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 description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "The virtual Network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "The domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "The netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "The project name of the VLAN range", + "name": "project", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "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": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "The end IP of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "The project ID of the VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "Path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the VLAN IP range", + "description": "The domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "The start IP of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "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", + "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", + "description": "The CIDR of the VLAN IP range", + "name": "cidr", "type": "string" - } + }, + {} ], "since": "4.16.0" }, @@ -144073,89 +144098,89 @@ "name": "listResourceLimits", "params": [ { - "description": "Tag for the resource type", + "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": "tag", + "name": "resourcetype", "required": false, - "since": "4.20.0", - "type": "string" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "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": "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": "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. ", + "description": "Lists resource limits by ID.", "length": 255, - "name": "resourcetypename", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { - "description": "list only resources belonging to the domain specified", + "description": "Tag for the resource type", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "tag", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "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 by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Lists resource limits 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", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of Instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of Snapshots an account can own. template - Template. Number of Templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "keyword", + "name": "resourcetypename", "required": false, "type": "string" } @@ -144163,65 +144188,65 @@ "related": "", "response": [ { - "description": "the account of the resource limit", - "name": "account", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, + {}, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "The project ID of the resource limit", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain ID of the resource limit", + "description": "The domain ID of the resource limit", "name": "domainid", "type": "string" }, + {}, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "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", + "description": "The maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "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 Account of the resource limit", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the resource limit", - "name": "domain", - "type": "string" - }, - { - "description": "The tag for the resource limit", - "name": "tag", + "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": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "The project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "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" } ] @@ -144243,17 +144268,22 @@ "related": "getUser", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "The user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user ID", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "The user ID", "name": "id", "type": "string" }, @@ -144262,122 +144292,117 @@ "name": "icon", "type": "resourceiconresponse" }, + {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "The 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 domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 user state", - "name": "state", + "description": "The Account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "The user email address", + "name": "email", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "The user state", + "name": "state", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the ID of the role", - "name": "roleid", + "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", + "description": "True if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "The boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the 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" } ] }, @@ -144387,147 +144412,147 @@ "name": "listIsos", "params": [ { - "description": "the ID of the OS category for the ISO", + "description": "True if the ISO is bootable, false otherwise", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "bootable", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list ISO by ID", + "description": "The hypervisor for which to restrict the search", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the storage pool", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "pagesize", "required": false, - "since": "4.19", - "type": "uuid" + "type": "integer" }, { - "description": "ID of the image or image cache store", + "description": "the ID of the OS category for the ISO", "length": 255, - "name": "imagestoreid", - "related": "listSwifts", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "since": "4.19", + "since": "4.21.0", "type": "uuid" }, { - "description": "flag to display the resource image for the isos", + "description": "List all ISOs by name", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "If set to true, list only unique ISOs across zones", "length": 255, - "name": "keyword", + "name": "showunique", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" }, { - "description": "list ISOs that are 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": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "arch", + "name": "projectid", + "related": "", "required": false, - "since": "4.20", - "type": "string" + "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": "List only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomains", "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": "ID of the storage pool", "length": 255, - "name": "isrecursive", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "boolean" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "page", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "", "length": 255, - "name": "ispublic", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "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 Instance. * 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 an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).", "length": 255, - "name": "hypervisor", + "name": "isofilter", "required": false, "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "Show removed ISOs as well", "length": 255, - "name": "isofilter", + "name": "showremoved", "required": false, - "type": "string" + "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" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List ISO by ID", "length": 255, - "name": "account", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list all ISOs by name", + "description": "The ID of the zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -144537,154 +144562,237 @@ "type": "boolean" }, { - "description": "If set to true, list only unique isos across zones", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "showunique", + "name": "tags", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "map" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "True if the ISO is publicly available to all Users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "the ID of the zone", + "description": "If True, list ISOs that are ready to be deployed.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isready", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "show removed ISOs as well", + "description": "ID of the image or image cache store", "length": 255, - "name": "showremoved", + "name": "imagestoreid", + "related": "listSwifts", "required": false, - "type": "boolean" + "since": "4.19", + "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", + "description": "The Account name to which the Template belongs", + "name": "account", + "type": "string" + }, + {}, + { + "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 date this Template was created", + "name": "created", + "type": "date" + }, + { + "description": "The Template ID", + "name": "id", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The Template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" + }, + { + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" + }, + { + "description": "The size of the Template", + "name": "size", + "type": "long" + }, + { + "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": "The hypervisor on which the Template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "The project name of the Template", + "name": "project", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is Template", "name": "deployasisdetails", "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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", + "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", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "The date this Template was removed", + "name": "removed", + "type": "date" }, { - "description": "the template ID", - "name": "id", + "description": "The id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The name of the domain to which the Template belongs", + "name": "domain", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The ID of the zone for this Template", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The name of the OS type for this Template.", + "name": "ostypename", + "type": "string" }, + {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the list of resource tags associated", + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", + "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": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" } @@ -144692,236 +144800,153 @@ "type": "set" }, { - "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": "the name of the zone for this template", - "name": "zonename", + "description": "The tag of this Template", + "name": "templatetag", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "VMware only: 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 type of the Template", + "name": "templatetype", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", "name": "childtemplates", "type": "set" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.", + "name": "deployasis", "type": "boolean" }, { - "description": "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": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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": "the tag of this template", - "name": "templatetag", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "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 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 zone for this Template", + "name": "zonename", "type": "string" }, - {}, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The 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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "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 ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "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": "CPU Arch of the template", - "name": "arch", - "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": "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", + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", "type": "string" } ] @@ -144932,89 +144957,89 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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 autoscale vm group", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "vmgroupid", + "name": "projectid", "related": "", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the condition of the policy", "length": 255, - "name": "projectid", + "name": "conditionid", "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "The action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "name", + "name": "action", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the ID of the condition of the policy", + "description": "The ID of the autoscale Instance group", "length": 255, - "name": "conditionid", + "name": "vmgroupid", "related": "", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "The name of the autoscale policy", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "action", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the autoscale policy", + "description": "The ID of the autoscale policy", "length": 255, "name": "id", "related": "listAutoScalePolicies", @@ -145032,75 +145057,75 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "The project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "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 autoscale policy ID", + "name": "id", + "type": "string" }, + {}, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "The list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "The domain name of the autoscale policy", + "name": "domain", "type": "string" }, + {}, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "The action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "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", + "description": "The cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "the autoscale policy ID", - "name": "id", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, - {}, { - "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": "name of the autoscale policy", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "Name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "The domain ID of the autoscale policy", + "name": "domainid", "type": "string" } ] @@ -145118,13 +145143,6 @@ "required": false, "type": "uuid" }, - { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Id of the guest network IPv4 subnet", "length": 255, @@ -145133,6 +145151,13 @@ "required": true, "type": "uuid" }, + { + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "domain ID of the account owning the IPv4 subnet", "length": 255, @@ -145145,8 +145170,8 @@ "related": "", "response": [ { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { @@ -145155,13 +145180,8 @@ "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { @@ -145170,18 +145190,13 @@ "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -145189,23 +145204,33 @@ "name": "domain", "type": "string" }, + {}, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, {}, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, - {} + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + } ], "since": "4.20.0" }, @@ -145215,40 +145240,43 @@ "name": "listSharedFileSystems", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the disk offering of the shared filesystem", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "diskofferingid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the availability zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the disk offering of the shared filesystem", "length": 255, - "name": "isrecursive", + "name": "diskofferingid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the service offering of the shared filesystem", @@ -145259,7 +145287,14 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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, @@ -145273,82 +145308,67 @@ "type": "integer" }, { - "description": "the name of the shared filesystem", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of the availability zone", + "description": "the ID of the network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "Makes the API's response contains only the resource count", "length": 255, "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "the ID of the network", + "description": "the ID of the shared filesystem", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "required": false, "type": "uuid" }, { - "description": "the ID of the shared filesystem", + "description": "the name of the shared filesystem", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "related": "changeSharedFileSystemDiskOffering", "response": [ { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -145357,23 +145377,28 @@ "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { @@ -145381,345 +145406,345 @@ "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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": "isdefault", - "type": "boolean" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", + "description": "Name of the VPC to which the NIC belongs", "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The 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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "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 isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of IPv6 network", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The gateway of IPv6 Network", "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "list" }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, { "description": "provisioning type used in the shared filesystem", "name": "provisioningtype", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, { "description": "ID of the storage fs vm", "name": "vmstate", "type": "string" }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, { "description": "the account associated with the shared filesystem", "name": "account", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", + "description": "Resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - {}, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" }, { "description": "disk offering for the shared filesystem has custom size", @@ -145727,48 +145752,48 @@ "type": "boolean" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, { "description": "Network ID of the shared filesystem", "name": "networkid", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -145776,12 +145801,12 @@ "since": "4.20.0" }, { - "description": "adds baremetal rack configuration text", + "description": "Adds baremetal rack configuration text", "isasync": true, "name": "addBaremetalRct", "params": [ { - "description": "http url to baremetal RCT configuration", + "description": "HTTP URL to baremetal RCT configuration", "length": 255, "name": "baremetalrcturl", "required": true, @@ -145791,25 +145816,25 @@ "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", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "url", - "name": "url", + "description": "ID of RCT", + "name": "id", "type": "string" } ] @@ -145820,45 +145845,45 @@ "name": "updateRole", "params": [ { - "description": "The description of the role", + "description": "Creates a role with this unique name", "length": 255, - "name": "description", + "name": "name", "required": false, "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" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "ID of the role", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "id", + "related": "listRoles,updateRole", + "required": true, + "type": "uuid" }, { - "description": "creates a role with this unique name", + "description": "The description of the role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "ID of the role", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "id", - "related": "listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "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" } @@ -145866,111 +145891,115 @@ "related": "listRoles", "response": [ { - "description": "the name of the role", + "description": "The name of the role", "name": "name", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "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 ID of the role", + "description": "The ID of the role", "name": "id", "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 state of the role", - "name": "state", + "description": "The type of the role", + "name": "type", "type": "string" }, + {}, { - "description": "the description of the role", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" }, { - "description": "Lists remote access vpns", + "description": "Lists remote access VPNs", "isasync": false, "name": "listRemoteAccessVpns", "params": [ { - "description": "List by keyword", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "Lists remote access VPN rule with the specified ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listRemoteAccessVpns", "required": false, - "type": "integer" + "since": "4.3", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Public ip address id of the VPN server", "length": 255, - "name": "isrecursive", + "name": "publicipid", + "related": "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 objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns", + "name": "fordisplay", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List remote access VPNs for certain Network", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { "description": "", @@ -145980,24 +146009,21 @@ "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list remote access VPNs for certain network", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "isrecursive", "required": false, - "since": "4.3", - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -146005,92 +146031,91 @@ "type": "uuid" }, { - "description": "public ip address id of the vpn server", + "description": "List by keyword", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "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 vpn for display to the regular user", + "description": "Is VPN for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "The Account of the remote access VPN", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "The ID of the remote access VPN", + "name": "id", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "The IPSec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", + "description": "The domain name of the Account of the remote access VPN", "name": "domain", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "The 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" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "The public IP address of the VPN server", + "name": "publicipid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The range of IPs to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "Path of the domain to which the remote access VPN belongs", + "name": "domainpath", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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 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 public IP address of the VPN server", + "name": "publicip", "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -146110,25 +146135,25 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {} ], @@ -146140,7 +146165,7 @@ "name": "deleteNetworkACLList", "params": [ { - "description": "the ID of the network ACL", + "description": "The ID of the network ACL", "length": 255, "name": "id", "related": "createNetworkACLList", @@ -146150,25 +146175,25 @@ ], "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", + "description": "The current status of the latest 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": "True if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -146179,7 +146204,7 @@ "name": "removeIpFromNic", "params": [ { - "description": "the ID of the secondary ip address to nic", + "description": "The ID of the secondary ip address to NIC", "length": 255, "name": "id", "related": "", @@ -146189,26 +146214,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, @@ -146217,6 +146242,14 @@ "isasync": true, "name": "createServiceInstance", "params": [ + { + "description": "The service offering ID that defines the resources consumed by the service appliance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, { "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -146225,26 +146258,26 @@ "type": "string" }, { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "Project ID for the service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "The right (outside) network ID for the service instance", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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": "listZones", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, @@ -146257,10 +146290,10 @@ "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": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, @@ -146278,84 +146311,76 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the virtual machine", - "name": "name", + "description": "The project ID of the Instance", + "name": "projectid", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Path of the Domain in which the Instance exists", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "The ID of the domain in which the Instance exists", "name": "domainid", "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": "path of the Domain in which the virtual machine exists", - "name": "domainpath", + "description": "The account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", "name": "displayname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The ID of the Instance", + "name": "id", "type": "string" - } + }, + {} ] }, { - "description": "Starts a system virtual machine.", + "description": "Starts a System VM.", "isasync": true, "name": "startSystemVm", "params": [ { - "description": "The ID of the system virtual machine", + "description": "The ID of the System VM", "length": 255, "name": "id", "related": "startSystemVm", @@ -146366,210 +146391,210 @@ "related": "", "response": [ { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "The private MAC address for the System VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", + "description": "The number of active console sessions for the console proxy System VM", "name": "activeviewersessions", "type": "integer" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "The Template ID for the System VM", + "name": "templateid", "type": "string" }, + {}, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "Public VLAN range", + "name": "publicvlan", + "type": "list" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "The systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "The state of the System VM", + "name": "state", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Template name for the System VM", + "name": "templatename", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "The System VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The public netmask for the System VM", + "name": "publicnetmask", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "description": "The last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "The hostname for the System VM", + "name": "hostname", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "The control state of the host for the System VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the link local MAC address for the system vm", + "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 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 public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "The date and time the System VM was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "The Network domain for the System VM", + "name": "networkdomain", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "The Zone ID for the System VM", + "name": "zoneid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "The private netmask for the System VM", + "name": "privatenetmask", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The agent state of the System VM", + "name": "agentstate", "type": "string" }, { - "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 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": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "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 template ID for the system VM", - "name": "templateid", + "description": "The Pod name for the System VM", + "name": "podname", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "The Zone name for the System VM", + "name": "zonename", + "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": "CPU arch of the system VM", - "name": "arch", + "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 gateway for the System VM", + "name": "gateway", + "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "The ID of the System VM", + "name": "id", + "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 second DNS for the system VM", - "name": "dns2", + "description": "The host ID for the System VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "The private IP address for the System VM", + "name": "privateip", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "The link local netmask for the System VM", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The Control IP address for the System VM", + "name": "linklocalip", "type": "string" } ] @@ -146580,599 +146605,599 @@ "name": "registerVnfTemplate", "params": [ { - "description": "true if the template is available to all accounts; default is true", + "description": "ID of the extension", "length": 255, - "name": "ispublic", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "bits", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "The tag for this Template.", "length": 255, - "name": "isdynamicallyscalable", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "True if the Template or its derivatives are extractable; default is false", "length": 255, - "name": "sshkeyenabled", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "Register template for the project", + "description": "The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template", "length": 255, - "name": "projectid", + "name": "ostypeid", "related": "", "required": false, "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "True if the Template is available to all accounts; default is true", "length": 255, - "name": "externaldetails", + "name": "ispublic", "required": false, - "since": "4.21.0", - "type": "map" + "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": "The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "checksum", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", + "description": "The display text of the Template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "map" + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", + "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 CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "arch", + "name": "details", "required": false, - "since": "4.20", - "type": "string" + "type": "map" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "checksum", "required": false, - "type": "uuid" + "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": "32 or 64 bits support. 64 by default", "length": 255, - "name": "zoneids", - "related": "listZones", + "name": "bits", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "isfeatured", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { - "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": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the template", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "vnfdetails", + "required": false, + "type": "map" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "length": 255, + "name": "vnfnics", "required": false, - "type": "string" + "type": "map" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "True if the Template type is routing i.e., if Template is used to deploy router", "length": 255, - "name": "isextractable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "description": "The ID of the zone the Template is to be hosted on", "length": 255, - "name": "templatetag", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "True if this Template requires HVM", "length": 255, - "name": "deployasis", + "name": "requireshvm", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "forcks", + "name": "directdownload", "required": false, - "since": "4.21.0", "type": "boolean" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "The name of the Template", "length": 255, - "name": "vnfdetails", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "The target hypervisor for the Template", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "True if this Template is a featured Template, false otherwise", "length": 255, - "name": "details", + "name": "isfeatured", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "ostypeid", - "related": "", + "name": "externaldetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory", "length": 255, - "name": "templatetype", + "name": "isdynamicallyscalable", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "True if the Template supports the password reset feature; default is false", "length": 255, - "name": "directdownload", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "True if the Template supports the sshkey upload feature; default is false", "length": 255, - "name": "account", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "Register Template for the project", "length": 255, - "name": "requireshvm", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "format", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "(VMware only) true if Instance deployments should preserve all the configurations defined for this Template", "length": 255, - "name": "passwordenabled", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "ID of the extension", + "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": "extensionid", - "related": "listExtensions", + "name": "zoneids", + "related": "listZones", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "list" } ], "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the status of the template", - "name": "status", + "description": "Checksum of the Template", + "name": "checksum", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "The date this Template was created", + "name": "created", + "type": "date" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "The date this Template was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The Template display text", + "name": "displaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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 type of the template", - "name": "templatetype", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", + "description": "True if the Template is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "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 tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "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 id of userdata linked to this template", - "name": "userdataid", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - {}, - { - "description": "the template ID", - "name": "id", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, {}, { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "VMware only: 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 the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the list of resource tags associated", + "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": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "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", + "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": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The Template name", + "name": "name", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "The processor bit size", + "name": "bits", + "type": "int" + }, + { + "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 tag of this Template", + "name": "templatetag", + "type": "string" + }, + { + "description": "True if this Template is a featured Template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "If root disk Template, then IDs of the datas disk Templates this Template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The name of the OS type for this Template.", + "name": "ostypename", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "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 name of the secondary storage host for the template", - "name": "hostname", + "description": "True if the Template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "True if the Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The type of the Template", + "name": "templatetype", + "type": "string" + }, + { + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "The project name of the Template", + "name": "project", + "type": "string" + }, + { + "description": "The Template ID", + "name": "id", "type": "string" }, { - "description": "the physical size of the template", + "description": "The physical size of the Template", "name": "physicalsize", "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The size of the Template", + "name": "size", + "type": "long" + }, + { + "description": "Lists the download progress of a Template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "The 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": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The id of userdata linked to this Template", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the zone for this template", + "description": "The ID of the zone for this Template", "name": "zoneid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {} + { + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" + }, + { + "description": "The name of the secondary storage host for the Template", + "name": "hostname", + "type": "string" + }, + { + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + } ], "since": "4.19.0" }, @@ -147182,41 +147207,41 @@ "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "List by keyword", + "description": "End date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the ID of the virtual machine.", + "description": "The ID of the Instance.", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "Name of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id.", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "The IDs of the Instances, mutually exclusive with id.", "length": 255, - "name": "startdate", + "name": "ids", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "date" + "type": "list" }, { "description": "", @@ -147226,136 +147251,136 @@ "type": "integer" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "", + "description": "Start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" } ], "related": "listSystemVmsUsageHistory", "response": [ { - "description": "the ID of the virtual machine", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the Instance", "name": "id", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The Name of the Instance", + "name": "name", "type": "string" }, + {}, { - "description": "the list of VM stats", + "description": "The list of Instance stats", "name": "stats", "response": [ { - "description": "the amount of downloaded data by the VM in MiB", - "name": "networkread", + "description": "The total disk IOPS since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "The amount (percentage) of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "description": "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", "name": "diskioread", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of uploaded data by the VM in MiB", - "name": "networkwrite", - "type": "string" + "description": "The target memory in Instance (KB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", + "name": "timestamp", + "type": "date" }, { - "description": "the VM's disk read in KiB", + "description": "The Instance's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the VM's free memory in KB or -1 if it cannot be gathered", - "name": "memoryintfreekbs", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the time when the VM stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", - "name": "timestamp", - "type": "date" + "description": "The amount of uploaded data by the Instance in MiB", + "name": "networkwrite", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total disk iops since the last stats retrieval", - "name": "diskiopstotal", + "description": "The Instance's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the memory used by the VM in KB", + "description": "The memory used by the Instance in KB", "name": "memorykbs", "type": "long" }, { - "description": "the amount (percentage) of the VM's CPU currently used", - "name": "cpuused", + "description": "The amount of downloaded data by the Instance in MiB", + "name": "networkread", "type": "string" }, { - "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "description": "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", "name": "diskiowrite", "type": "long" - }, - { - "description": "the target memory in VM (KB)", - "name": "memorytargetkbs", - "type": "long" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.17" }, { - "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", + "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host.", "isasync": true, "name": "declareHostAsDegraded", "params": [ { - "description": "host ID", + "description": "Host ID", "length": 255, "name": "id", "related": "declareHostAsDegraded,reconnectHost", @@ -147366,339 +147391,296 @@ "related": "reconnectHost", "response": [ { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "The amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "The Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "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 outgoing Network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "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 last pinged", - "name": "lastpinged", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "The IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "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 management server name of the host", - "name": "managementservername", + "description": "The Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "The Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "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": "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": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "The admin that annotated this host", + "name": "username", + "type": "string" }, + {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "The name of the host", + "name": "name", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "The last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "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": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum 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" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "The OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, - {}, + { + "description": "The Zone name of the host", + "name": "zonename", + "type": "string" + }, { "description": "Used GPUs on the Host", "name": "gpuused", "type": "long" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "The ID of the host", + "name": "id", "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 resource state of the host", - "name": "resourcestate", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "Capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "comma-separated list of tags for the host", + "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "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", - "type": "string" + "description": "The total disk size of the host", + "name": "disksizetotal", + "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 OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "The management server ID of the host", + "name": "managementserverid", + "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 virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "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 hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "The number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "The name of extension for this cluster", @@ -147706,19 +147688,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the 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 type", + "name": "type", + "type": "type" }, { "description": "CPU Arch of the host", @@ -147726,86 +147713,124 @@ "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "The host hypervisor", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "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", + "description": "The hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vGPU can be created with this vGPU type on the given GPU group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "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" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The host version", + "name": "version", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0.0" @@ -147816,27 +147841,25 @@ "name": "createKubernetesCluster", "params": [ { - "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", + "description": "External load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "nodeofferings", + "name": "externalloadbalanceripaddress", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "password for the docker image private registry", + "description": "URL for the docker image private registry", "length": 255, - "name": "dockerregistrypassword", + "name": "dockerregistryurl", "required": false, "type": "string" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "Number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "controlnodes", "required": false, - "type": "uuid" + "type": "long" }, { "description": "(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly", @@ -147847,44 +147870,20 @@ "type": "long" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster", + "description": "Name for the Kubernetes cluster", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "Deploy cluster for the project", "length": 255, - "name": "cniconfigurationid", + "name": "projectid", "related": "", "required": false, - "since": "4.21.0", - "type": "uuid" - }, - { - "description": "the ID of the service offering for the virtual machines in the cluster.", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, "type": "uuid" }, - { - "description": "number of Kubernetes cluster control nodes, default is 1", - "length": 255, - "name": "controlnodes", - "required": false, - "type": "long" - }, - { - "description": "name of the ssh key pair used to login to the virtual machines", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - }, { "description": "the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.", "length": 255, @@ -147902,43 +147901,39 @@ "type": "map" }, { - "description": "Deploy cluster for the project", + "description": "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "name for the Kubernetes cluster", + "description": "Availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "user name for the docker image private registry", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "dockerregistryusername", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "The ID of the service offering for the Instances in the cluster.", "length": 255, - "name": "account", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", - "length": 255, - "name": "externalloadbalanceripaddress", - "required": false, - "type": "string" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "description": "Type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", "length": 255, "name": "clustertype", "required": false, @@ -147946,9 +147941,9 @@ "type": "string" }, { - "description": "URL for the docker image private registry", + "description": "Name of the SSH key pair used to login to the Instances", "length": 255, - "name": "dockerregistryurl", + "name": "keypair", "required": false, "type": "string" }, @@ -147961,27 +147956,48 @@ "type": "map" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "Number of Kubernetes cluster worker nodes", "length": 255, - "name": "kubernetesversionid", - "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "root disk size in GB for each node", + "description": "User name for the docker image private registry", "length": 255, - "name": "noderootdisksize", + "name": "dockerregistryusername", "required": false, - "type": "long" + "type": "string" + }, + { + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", + "length": 255, + "name": "nodeofferings", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "description for the Kubernetes cluster", + "description": "Description for the Kubernetes cluster", "length": 255, "name": "description", "required": false, "type": "string" }, + { + "description": "Password for the docker image private registry", + "length": 255, + "name": "dockerregistrypassword", + "required": false, + "type": "string" + }, + { + "description": "Root disk size in GB for each node", + "length": 255, + "name": "noderootdisksize", + "required": false, + "type": "long" + }, { "description": "if true, setups up CloudStack CSI driver", "length": 255, @@ -147991,288 +148007,297 @@ "type": "boolean" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "An optional Account for the Instance. Must be used with domainId.", "length": 255, - "name": "masternodes", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "the AS Number of the network", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "asnumber", + "name": "kubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "Number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "size", + "name": "masternodes", "required": false, "type": "long" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "the ID of the Userdata", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "cniconfigurationid", + "related": "", + "required": false, + "since": "4.21.0", "type": "uuid" + }, + { + "description": "the AS Number of the network", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" } ], "related": "startKubernetesCluster", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "The ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", + "description": "The name of the network of the Kubernetes cluster", "name": "associatednetworkname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", + "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": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "The name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "The control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "The Account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", + "description": "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, + {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "The description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "The list of virtualmachines associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "The cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "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": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "The state of the Kubernetes cluster", + "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 ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, - {}, { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "keypair details", - "name": "keypair", + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "The ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "The ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "The project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "The name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "The size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "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 service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - {}, { "description": "the name of the service offering of the control nodes on the Kubernetes cluster", "name": "controlofferingname", "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": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" } ] }, @@ -148282,108 +148307,108 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "Optional parameter. Zone UUID, if specified and both pod UUID and range UUID are absent, using it to search the range.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Optional parameter. Storage network IP range UUID, if specified, using it to search the range.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "Optional parameter. Pod UUID, if specified and range UUID is absent, using it to search the range.", "length": 255, - "name": "page", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" + "description": "The ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, + {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "The end IP of the storage Network IP range", + "name": "endip", "type": "string" }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "The Network UUID of storage Network IP range", + "name": "networkid", + "type": "string" }, - {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "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 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", + "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 netmask of the storage Network IP range", + "name": "netmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The gateway of the storage Network IP range", + "name": "gateway", "type": "string" }, { - "description": "the 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 netmask of the storage network IP range", - "name": "netmask", + "description": "The UUID of storage Network IP range.", + "name": "id", "type": "string" } ], @@ -148395,79 +148420,79 @@ "name": "configureVirtualRouterElement", "params": [ { - "description": "Enabled/Disabled the service provider", + "description": "The ID of the virtual router provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureVirtualRouterElement", "required": true, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the virtual router provider", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, + {}, + {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "The ID of the router", + "name": "id", "type": "string" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "Path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "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", + "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 domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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 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", + "description": "The Account associated with the provider", + "name": "account", "type": "string" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" } ] }, @@ -148488,60 +148513,60 @@ "related": "disableHAForHost", "response": [ { - "description": "the HA state of the host", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "If host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "The HA state of the host", "name": "hastate", "type": "hastate" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "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 ID of the host", + "description": "The ID of the host", "name": "hostid", "type": "string" }, { - "description": "the host HA provider", + "description": "The host HA provider", "name": "haprovider", "type": "string" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" } ], "since": "4.11" }, { - "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "description": "Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect.", "isasync": true, "name": "updateVMAffinityGroup", "params": [ { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "The ID of the Instance", "length": 255, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "Comma separated list of affinity groups names that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, "name": "affinitygroupnames", "related": "", @@ -148549,1100 +148574,709 @@ "type": "list" }, { - "description": "The ID of the virtual machine", + "description": "Comma separated list of affinity groups id that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", "name": "instancename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "User VM type", + "name": "vmtype", "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "An optional field whether to the display the Instance 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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", "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": "User VM type", - "name": "vmtype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The name of the Instance", + "name": "name", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "OS name of the vm", + "description": "OS name of the Instance", "name": "osdisplayname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The project name of the Instance", + "name": "project", "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 isolation uri of the nic", - "name": "isolationuri", - "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 ID of the corresponding network", - "name": "networkid", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "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": "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" + "description": "Public IP address id associated with Instance 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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "Instance details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - {}, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", + "description": "The ID of the service offering of the Instance", "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", + "description": "The name of the security group", "name": "name", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "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", + "description": "The Account owning the security group", "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The ID of the security group", + "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "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" }, { - "description": "tag key name", - "name": "key", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The Account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", + "description": "The project id of the group", "name": "projectid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of egress rules associated with the security group", + "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", + "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": "account owning the security group rule", - "name": "account", + "description": "The ID of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "The ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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", + "description": "Security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", + "description": "The starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" } ], "type": "set" + }, + { + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "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": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { "description": "the name of the gpu card to which service offering is linked", @@ -149650,70 +149284,466 @@ "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "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": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "The name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "Instance 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 format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, { "description": "the count of GPUs on the virtual machine", "name": "gpucount", "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "The date when this Instance 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 control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, + { + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the video RAM size in MB", "name": "videoram", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "The list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "description": "The ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "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 IP address of the NIC", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "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 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 isolation URI of the NIC", + "name": "isolationuri", + "type": "string" + }, + { + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The ID of the corresponding Network", + "name": "networkid", + "type": "string" + }, + { + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "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" + } + ], + "type": "set" + }, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "type": "string" } ] }, @@ -149740,17 +149770,17 @@ "related": "listRegisteredServicePackages", "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": "Service Package UUID", "name": "id", "type": "string" }, {}, - {}, { "description": "Service Package Name", "name": "name", @@ -149762,9 +149792,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -149774,9 +149804,9 @@ "name": "updateWebhook", "params": [ { - "description": "State of the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "state", + "name": "scope", "required": false, "type": "string" }, @@ -149788,16 +149818,24 @@ "type": "string" }, { - "description": "Name for the Webhook", + "description": "The ID of the Webhook", "length": 255, - "name": "name", + "name": "id", + "related": "createWebhook", + "required": true, + "type": "uuid" + }, + { + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "length": 255, + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Scope of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "scope", + "name": "name", "required": false, "type": "string" }, @@ -149816,49 +149854,41 @@ "type": "string" }, { - "description": "The ID of the Webhook", - "length": 255, - "name": "id", - "related": "createWebhook", - "required": true, - "type": "uuid" - }, - { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "State of the Webhook", "length": 255, - "name": "sslverification", + "name": "state", "required": false, - "type": "boolean" + "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", + "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" }, { - "description": "Add +-credits to an account", + "description": "Add +-credits to an Account", "isasync": false, "name": "quotaCredits", "params": [ @@ -149870,13 +149900,6 @@ "required": true, "type": "uuid" }, - { - "description": "Value of the credits to be added+, subtracted-", - "length": 255, - "name": "value", - "required": true, - "type": "double" - }, { "description": "Account Id for which quota credits need to be added", "length": 255, @@ -149885,26 +149908,39 @@ "type": "string" }, { - "description": "Minimum balance threshold of the account", + "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", + "length": 255, + "name": "quota_enforce", + "required": false, + "type": "boolean" + }, + { + "description": "Minimum balance threshold of the Account", "length": 255, "name": "min_balance", "required": false, "type": "double" }, { - "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", + "description": "Value of the credits to be added+, subtracted-", "length": 255, - "name": "quota_enforce", - "required": false, - "type": "boolean" + "name": "value", + "required": true, + "type": "double" } ], "related": "", "response": [ + {}, { - "description": "When the credit was added.", - "name": "creditedon", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the creditor user.", @@ -149912,32 +149948,26 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The credit deposited.", + "name": "credit", + "type": "bigdecimal" }, { "description": "Username of the creditor user.", "name": "creditorusername", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" }, { "description": "Credit's currency.", "name": "currency", "type": "string" - }, - { - "description": "The credit deposited.", - "name": "credit", - "type": "bigdecimal" - }, - {}, - {} + } ], "since": "4.7.0" }, @@ -149946,6 +149976,13 @@ "isasync": false, "name": "discoverGpuDevices", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "ID of the host", "length": 255, @@ -149955,44 +149992,30 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "listGpuDevices", "response": [ { "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", - "type": "string" - }, - {}, - { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { @@ -150002,17 +150025,18 @@ }, { "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "name": "vgpuprofilename", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { @@ -150021,14 +150045,15 @@ "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { "description": "the state of the virtual machine to which this GPU device is allocated", @@ -150036,39 +150061,44 @@ "type": "state" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the managed state of the GPU device (Enabled/Disabled)", "name": "managedstate", "type": "managedstate" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the ID of the GPU device", - "name": "id", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" } ], "since": "4.21.0" @@ -150088,31 +150118,31 @@ ], "related": "", "response": [ + {}, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The client certificate", + "name": "certificate", "type": "string" }, {}, { - "description": "Private key for the certificate", - "name": "privatekey", + "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" + "description": "Private key for the certificate", + "name": "privatekey", + "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -150124,7 +150154,7 @@ "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the id of the direct download certificate to provision", + "description": "The id of the direct download certificate to provision", "length": 255, "name": "id", "related": "", @@ -150132,7 +150162,7 @@ "type": "uuid" }, { - "description": "the host to provision the certificate", + "description": "The host to provision the certificate", "length": 255, "name": "hostid", "related": "reconnectHost", @@ -150143,78 +150173,51 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "Indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "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" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the host", + "name": "hostname", "type": "string" }, {} ], "since": "4.17.0" }, - { - "description": "SAML Global Log Out API", - "isasync": false, - "name": "samlSlo", - "params": [], - "related": "", - "response": [ - { - "description": "Response description", - "name": "description", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {} - ] - }, { "description": "Creates a Project role", "isasync": false, "name": "updateProjectRole", "params": [ { - "description": "ID of project where role is being created", + "description": "Creates a project role with this unique name", "length": 255, - "name": "projectid", - "related": "", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "ID of the Project role", @@ -150225,16 +150228,17 @@ "type": "uuid" }, { - "description": "The description of the Project role", + "description": "ID of project where role is being created", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "creates a project role with this unique name", + "description": "The description of the Project role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" } @@ -150242,42 +150246,42 @@ "related": "", "response": [ { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "id", + "description": "The description of the role", + "name": "description", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "The ID of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the description of the role", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "The name of the role", + "name": "name", + "type": "string" }, - {}, { - "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 current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.15.0" }, @@ -150286,14 +150290,6 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Hostname", "length": 255, @@ -150301,6 +150297,14 @@ "required": true, "type": "string" }, + { + "description": "Linked domain", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "Port", "length": 255, @@ -150312,37 +150316,37 @@ "related": "", "response": [ { - "description": "linked domain", + "description": "Linked domain", "name": "domainid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the host running the LDAP server", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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 ID of the LDAP configuration", "name": "id", "type": "string" }, { - "description": "port the ldap server is running on", + "description": "Port the LDAP server is running on", "name": "port", "type": "int" }, - {} + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.2.0" }, @@ -150351,6 +150355,21 @@ "isasync": false, "name": "listImportVmTasks", "params": [ + { + "description": "the ID of the Account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, + "type": "string" + }, { "description": "Conversion host of the importing task", "length": 255, @@ -150368,11 +150387,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Filter tasks by state, valid options are: All, Running, Completed, Failed", @@ -150389,45 +150408,24 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, - "type": "string" - }, - { - "description": "the ID of the Account", + "description": "", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the total task duration", - "name": "duration", + "description": "the Zone name", + "name": "zonename", "type": "string" }, - {}, - { - "description": "the last updated date of the importing task", - "name": "lastupdated", - "type": "date" - }, { - "description": "the duration of the current step", - "name": "stepduration", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the create date of the importing task", @@ -150435,34 +150433,30 @@ "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the current step on the importing VM task", - "name": "step", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the name of the host on which the instance is being converted", - "name": "convertinstancehostname", + "description": "the total task duration", + "name": "duration", "type": "string" }, + {}, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the source VM name", + "name": "sourcevmname", "type": "string" }, { - "description": "the state of the importing VM task", - "name": "state", + "description": "the vcenter name of the importing VM task", + "name": "vcenter", "type": "string" }, {}, { - "description": "the display name of the importing VM", - "name": "displayname", + "description": "the ID of importing task", + "name": "id", "type": "string" }, { @@ -150471,8 +150465,13 @@ "type": "string" }, { - "description": "the ID of account", - "name": "accountid", + "description": "the current step description on the importing VM task", + "name": "description", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -150480,60 +150479,65 @@ "name": "account", "type": "string" }, + { + "description": "the ID of the imported VM (after task is completed)", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the ID of the host on which the instance is being converted", "name": "convertinstancehostid", "type": "string" }, { - "description": "the ID of the imported VM (after task is completed)", - "name": "virtualmachineid", + "description": "the duration of the current step", + "name": "stepduration", "type": "string" }, { - "description": "the vcenter name of the importing VM task", - "name": "vcenter", + "description": "the name of the host on which the instance is being converted", + "name": "convertinstancehostname", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the display name of the importing VM", + "name": "displayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the importing VM task", + "name": "state", "type": "string" }, { - "description": "the ID of importing task", - "name": "id", - "type": "string" + "description": "the last updated date of the importing task", + "name": "lastupdated", + "type": "date" }, { - "description": "the source VM name", - "name": "sourcevmname", + "description": "the current step on the importing VM task", + "name": "step", "type": "string" }, { - "description": "the current step description on the importing VM task", - "name": "description", + "description": "the ID of account", + "name": "accountid", "type": "string" } ], "since": "4.22" }, { - "description": "create Tungsten-Fabric address group", + "description": "Create Tungsten-Fabric address group", "isasync": true, "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "Tungsten-Fabric ip prefix length", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "ipprefixlen", + "name": "ipprefix", "required": true, - "type": "integer" + "type": "string" }, { "description": "Tungsten-Fabric address group name", @@ -150543,64 +150547,64 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ipprefixlen", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Tungsten-Fabric ip prefix", + "description": "The ID of zone", "length": 255, - "name": "ipprefix", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "description": "Tungsten-Fabric address group IP prefix", + "name": "ipprefix", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric address group UUID", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", + "description": "Tungsten-Fabric address group IP prefix length", "name": "ipprefixlen", "type": "int" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" + }, + {}, + {}, + { + "description": "Tungsten-Fabric provider zone ID", + "name": "zoneid", + "type": "long" } ] }, @@ -150610,14 +150614,14 @@ "name": "listBigSwitchBcfDevices", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "bigswitch BCF controller device ID", + "description": "Bigswitch BCF controller device ID", "length": 255, "name": "bcfdeviceid", "related": "listBigSwitchBcfDevices", @@ -150625,97 +150629,90 @@ "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "The Physical Network ID", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "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": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "The controller password", + "name": "password", "type": "string" }, + {}, { - "description": "device name", + "description": "Device name", "name": "bigswitchdevicename", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + { + "description": "The physical Network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the controller username", + "description": "The controller username", "name": "username", "type": "string" }, - {}, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "The controller IP address", + "name": "hostname", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "Device ID of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, {}, { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.6.0" }, { - "description": "lists registered service packages", + "description": "Lists registered service packages", "isasync": false, "name": "listRegisteredServicePackages", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -150729,6 +150726,13 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -150738,25 +150742,25 @@ "name": "description", "type": "string" }, + {}, { - "description": "Service Package UUID", - "name": "id", + "description": "Service Package Name", + "name": "name", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "Service Package Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } @@ -150768,24 +150772,24 @@ "name": "changeSharedFileSystemDiskOffering", "params": [ { - "description": "the ID of the shared filesystem", + "description": "the disk offering to use for the underlying storage", "length": 255, - "name": "id", - "related": "changeSharedFileSystemDiskOffering", - "required": true, + "name": "diskofferingid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "max iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, { - "description": "the size of the shared filesystem in GiB", + "description": "max iops", "length": 255, - "name": "size", + "name": "maxiops", "required": false, "type": "long" }, @@ -150797,204 +150801,174 @@ "type": "long" }, { - "description": "the disk offering to use for the underlying storage", + "description": "the ID of the shared filesystem", "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", + "description": "Tag key name", "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - {}, - { - "description": "the disk utilization", - "name": "utilization", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, { "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "name of the shared filesystem", - "name": "name", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" }, { "description": "Name of the availability zone", @@ -151002,18 +150976,13 @@ "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { @@ -151022,63 +150991,48 @@ "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { @@ -151086,43 +151040,33 @@ "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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 ID of the corresponding network", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { @@ -151131,69 +151075,64 @@ "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", + "description": "The IP address of the NIC", "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", + "description": "The extra DHCP options on the NIC", "name": "extradhcpoption", "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" }, { "description": "ID of the VLAN/VNI if available", @@ -151201,47 +151140,112 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the nic", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The ID of the NIC", "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", + "description": "The gateway of IPv6 Network", "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "MTU configured on the NIC", + "name": "mtu", + "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", "type": "string" } ], "type": "list" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" } ], "since": "4.20.0" @@ -151252,7 +151256,7 @@ "name": "enableStaticNat", "params": [ { - "description": "the public IP address ID for which static NAT feature is being enabled", + "description": "The public IP address ID for which static NAT feature is being enabled", "length": 255, "name": "ipaddressid", "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -151260,52 +151264,52 @@ "type": "uuid" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", + "description": "The ID of the Instance for enabling static NAT feature", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "The Network of the Instance 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", "required": false, - "type": "string" + "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", + "name": "vmguestip", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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", + "description": "Any text associated with the 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - {} + } ] }, { @@ -151314,7 +151318,7 @@ "name": "deleteZone", "params": [ { - "description": "the ID of the Zone", + "description": "The ID of the Zone", "length": 255, "name": "id", "related": "listZones", @@ -151323,28 +151327,28 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -151363,149 +151367,154 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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.20.0" }, { - "description": "upload an existing template into the CloudStack cloud. ", + "description": "Upload an existing Template into the CloudStack cloud. ", "isasync": false, "name": "getUploadParamsForTemplate", "params": [ { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "forcks", + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "length": 255, + "name": "isdynamicallyscalable", "required": false, - "since": "4.21.0", "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "Upload Volume/Template/ISO for the project", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "The tag for this Template.", "length": 255, - "name": "sshkeyenabled", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "checksum", + "required": false, + "type": "string" }, { - "description": "the tag for this template.", + "description": "True if this Template requires HVM", "length": 255, - "name": "templatetag", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the volume/template/iso", + "description": "True if this Template is a featured Template, false otherwise", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "projectid", - "related": "", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "type": "string" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "True if the Template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "The target hypervisor for the Template", "length": 255, "name": "hypervisor", "required": true, "type": "string" }, { - "description": "true if this template requires HVM", + "description": "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "True if the Template supports the SSHkey upload feature; default is false", "length": 255, - "name": "deployasis", + "name": "sshkeyenabled", "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": "The name of the Volume/Template/ISO", "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "True if the Template type is routing i.e., if Template is used to deploy router", "length": 255, - "name": "account", + "name": "isrouting", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "An optional domainId. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "isfeatured", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "True if the Template is available to all accounts; default is true", "length": 255, - "name": "isextractable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "True if the Template or its derivatives are extractable; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "isextractable", "required": false, "type": "boolean" }, @@ -151517,152 +151526,147 @@ "type": "map" }, { - "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": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "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": "ispublic", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "bits", + "name": "templatetype", "required": false, - "type": "integer" + "since": "4.22.0", + "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "The ID of the zone the Volume/Template/ISO is to be hosted on", "length": 255, - "name": "format", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "templatetype", + "name": "forcks", "required": false, - "since": "4.22.0", - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "(VMware only) true if Instance deployments should preserve all the configurations defined for this Template", "length": 255, - "name": "passwordenabled", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", + "description": "The display text of the Template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.20", "type": "string" } ], "related": "getUploadParamsForIso", "response": [ { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - { - "description": "the current status of the latest async job acting on this object", + "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.", + "description": "Encrypted data to be sent in the POST request.", "name": "metadata", "type": "string" }, + {}, { - "description": "the timestamp after which the signature expires", + "description": "The timestamp after which the signature expires", "name": "expires", "type": "string" }, - {}, { - "description": "signature to be sent in the POST request.", + "description": "Signature to be sent in the POST request.", "name": "signature", "type": "string" }, { - "description": "the template/volume ID", + "description": "The Template/volume ID", "name": "id", "type": "uuid" }, {}, { - "description": "the UUID of the latest async job acting on this object", + "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" } ], "since": "4.6.0" }, { - "description": "Deletes snapshot policies for the account.", + "description": "Deletes Snapshot policies for the account.", "isasync": false, "name": "deleteSnapshotPolicies", "params": [ { - "description": "the Id of the snapshot policy", + "description": "List of Snapshots policy IDs separated by comma", "length": 255, - "name": "id", + "name": "ids", "related": "updateSnapshotPolicy", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list of snapshots policy IDs separated by comma", + "description": "The ID of the Snapshot policy", "length": 255, - "name": "ids", + "name": "id", "related": "updateSnapshotPolicy", "required": false, - "type": "list" + "type": "uuid" } ], "response": [ {}, { - "description": "the current status of the latest async job acting on this object", + "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", + "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" - } + {} ] }, { @@ -151682,18 +151686,8 @@ "related": "", "response": [ { - "description": "Netris Tag for vNets", - "name": "netristag", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "Netris Provider name", + "name": "name", "type": "string" }, { @@ -151701,20 +151695,21 @@ "name": "netrisurl", "type": "string" }, - {}, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, + {}, + {}, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { @@ -151722,17 +151717,26 @@ "name": "sitename", "type": "string" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Netris provider uuid", "name": "uuid", "type": "string" }, { - "description": "Netris Provider name", - "name": "name", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, - {} + { + "description": "Netris Admin tenant name", + "name": "tenantname", + "type": "string" + } ], "since": "4.21.0" }, @@ -151742,25 +151746,25 @@ "name": "listTrafficTypeImplementors", "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", @@ -151773,99 +151777,99 @@ "related": "", "response": [ { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "network traffic type", - "name": "traffictype", + "description": "Implementor of Network traffic type", + "name": "traffictypeimplementor", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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" }, {} ], "since": "3.0.0" }, { - "description": "list the db hosts and statistics", + "description": "List the db hosts and statistics", "isasync": false, "name": "listDbMetrics", "params": [], "related": "", "response": [ { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" + "description": "The last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" }, - {}, { - "description": "the version of the currently running DB", - "name": "version", - "type": "string" + "description": "The uptime of the DB in seconds", + "name": "uptime", + "type": "long" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", + "description": "The name of the active usage server", + "name": "hostname", "type": "string" }, + {}, { - "description": "the time these statistics were collected", + "description": "The time these statistics were collected", "name": "collectiontime", "type": "date" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" - }, - { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "The TLS versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", + "description": "The number of queries performed on the DB", + "name": "queries", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The state of the usage server", + "name": "replicas", + "type": "string[]" }, { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "The version of the currently running DB", + "name": "versioncomment", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The number of connections to the DB", + "name": "connections", + "type": "int" }, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "The version of the currently running DB", + "name": "version", + "type": "string" }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.17.0" }, @@ -151884,25 +151888,25 @@ } ], "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", + "description": "The 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -151910,61 +151914,50 @@ "since": "4.2.0" }, { - "description": "Lists autoscale vm profiles.", + "description": "Lists autoscale Instance profiles.", "isasync": false, "name": "listAutoScaleVmProfiles", "params": [ { - "description": "list profiles by service offering id", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the templateid of the autoscale vm profile", + "description": "List by keyword", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the autoscale Instance profile", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, "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": "listZones", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -151972,165 +151965,176 @@ "type": "uuid" }, { - "description": "the ID of the autoscale vm profile", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "The templateid of the autoscale Instance profile", "length": 255, - "name": "pagesize", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,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.", + "description": "List profiles by service offering id", "length": 255, - "name": "isrecursive", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "The otherdeployparameters of the autoscale Instance profile", "length": 255, "name": "otherdeployparams", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "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": "Availability zone for the auto deployed Instance", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "the project id vm profile", - "name": "projectid", + "description": "Base64 encoded Instance user data", + "name": "userdata", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain ID of the Instance profile", + "name": "domainid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The ID of the User used to launch and destroy the Instances", + "name": "autoscaleuserid", "type": "string" }, + {}, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "The project name of the Instance profile", + "name": "project", "type": "string" }, + {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The domain name of the Instance profile", + "name": "domain", "type": "string" }, - {}, - {}, - {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "The Account owning the Instance group", + "name": "account", + "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" + "description": "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 name of the vm profile", - "name": "project", + "description": "The availability zone to be used while deploying an Instance", + "name": "zoneid", "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 an Instance", + "name": "otherdeployparams", + "type": "map" }, + {}, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "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 service offering to be used while deploying an Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "The time allowed for existing connections to get closed before an Instance is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "The autoscale Instance profile ID", + "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "The project id Instance profile", + "name": "projectid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The Template to be used while deploying an Instance", + "name": "templateid", "type": "string" } ] @@ -152141,62 +152145,63 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "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": "securitygroupname", + "name": "protocol", "required": false, "type": "string" }, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "end port for this ingress rule", + "description": "An optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "endport", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "user to security group mapping", + "description": "User to security group mapping", "length": 255, "name": "usersecuritygrouplist", "required": false, "type": "map" }, { - "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": "", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "start port for this ingress rule", + "description": "Start port for this ingress rule", "length": 255, "name": "startport", "required": false, "type": "integer" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "An optional project of the security group", "length": 255, - "name": "cidrlist", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "An optional account for the security group. Must be used with domainId.", "length": 255, - "name": "protocol", + "name": "account", "required": false, "type": "string" }, + { + "description": "Error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, { "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, @@ -152206,148 +152211,147 @@ "type": "uuid" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "error code for this icmp message", + "description": "End port for this ingress rule", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "Type of the icmp message being sent", "length": 255, - "name": "account", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + {}, + { + "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 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" + }, { - "description": "the list of resource tags associated with the rule", + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "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", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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" } ], "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 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", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ending IP of the security group rule ", + "description": "The ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "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", + "description": "Security group name", "name": "securitygroupname", "type": "string" - }, - {}, - { - "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" } ] }, @@ -152368,74 +152372,99 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the pool's currently used disk size", - "name": "disksizeused", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "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 pool's currently allocated disk size", + "name": "disksizeallocated", "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 Pod name of the storage pool", - "name": "podname", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "The pool's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "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 ID of the storage pool", - "name": "id", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", + "description": "Total min IOPS currently in use by volumes", "name": "allocatediops", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The tags for the storage pool", + "name": "tags", "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 IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -152444,110 +152473,85 @@ "type": "boolean" }, { - "description": "the Zone name of the storage pool", + "description": "The Zone name of the storage pool", "name": "zonename", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "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 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 date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "The ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "Storage provider for this pool", "name": "provider", "type": "string" }, - {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "The scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "The storage pool type", + "name": "type", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "The name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "The 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 storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the pool's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "bytes CloudStack can provision from this storage pool", "name": "capacitybytes", "type": "long" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the storage pool path", - "name": "path", - "type": "string" } ], "since": "4.15.1" @@ -152558,11 +152562,19 @@ "name": "updateBucket", "params": [ { - "description": "Enable/Disable Bucket Versioning", + "description": "Bucket Quota in GiB", "length": 255, - "name": "versioning", + "name": "quota", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { "description": "Bucket Access Policy", @@ -152579,43 +152591,35 @@ "type": "boolean" }, { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "Bucket Quota in GiB", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "quota", + "name": "versioning", "required": false, - "type": "integer" + "type": "boolean" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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", + "description": "True 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.19.0" @@ -152626,76 +152630,71 @@ "name": "updateResourceCount", "params": [ { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "description": "Update resource limits for project", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": true, + "name": "projectid", + "related": "", + "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. ", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "resourcetype", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "Tag for the resource type", "length": 255, - "name": "account", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "Update resource limits for project", + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of Instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of Snapshots a user can create. 4 - Template. Number of Templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "projectid", - "related": "", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Tag for the resource type", + "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": "tag", - "required": false, - "since": "4.20.0", - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the domain name for which resource count's are updated", - "name": "domain", - "type": "string" - }, - { - "description": "the project id for which resource count's are updated", + "description": "The project ID for which resource count's are updated", "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The domain name for which resource count's are updated", + "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", + "description": "The Account for which resource count's are updated", + "name": "account", "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": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "Tag for the resource", + "name": "tag", "type": "string" }, { @@ -152704,29 +152703,34 @@ "type": "long" }, { - "description": "the project name for which resource count's are updated", + "description": "The project name for which resource count's are updated", "name": "project", "type": "string" }, { - "description": "Tag for the resource", - "name": "tag", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the resource counts are updated", - "name": "domainpath", + "description": "Resource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "Path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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", + "type": "string" } ] }, @@ -152743,137 +152747,137 @@ "type": "integer" }, { - "description": "", + "description": "List role by role name.", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List role by role type status, valid options are: enabled, disabled", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "state", + "name": "type", "required": false, "type": "string" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "List role by role ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "listRoles", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List role by role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List role by role ID.", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "id", - "related": "listRoles", + "name": "state", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "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": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, - {}, { - "description": "the description of the role", - "name": "description", + "description": "The type of the role", + "name": "type", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of the role", + "name": "id", "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "The name of the role", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.9.0" }, { - "description": "list Tungsten-Fabric policy", + "description": "List Tungsten-Fabric policy", "isasync": false, "name": "listTungstenFabricPolicy", "params": [ { - "description": "", + "description": "The ID of ip address", "length": 255, - "name": "page", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "List by keyword", "length": 255, - "name": "policyuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of ip address", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "The uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", + "name": "policyuuid", "required": false, "type": "string" }, { - "description": "the ID of network", + "description": "The ID of network", "length": 255, "name": "networkid", "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", @@ -152881,48 +152885,42 @@ "type": "uuid" }, { - "description": "", + "description": "The ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {}, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -152930,12 +152928,18 @@ "name": "name", "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - } + "description": "List Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ] }, { @@ -152962,87 +152966,87 @@ "related": "extractSnapshot,extractTemplate", "response": [ { - "description": "the status of the extraction", - "name": "status", + "description": "The Account ID to which the extracted object belongs", + "name": "accountid", "type": "string" }, + {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "The upload ID of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone name the object was extracted from", + "name": "zonename", + "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "The state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", + "description": "The percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "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 mode of extraction - upload or download", - "name": "extractMode", + "description": "The name of the extracted object", + "name": "name", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "The status of the extraction", + "name": "status", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", - "type": "string" + "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", + "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 upload id of extracted object", - "name": "extractId", + "description": "The ID of extracted object", + "name": "id", "type": "string" }, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "Type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "The mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "Zone ID the object was extracted from", + "name": "zoneid", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -153052,7 +153056,7 @@ "name": "getCloudIdentifier", "params": [ { - "description": "the user ID for the cloud identifier", + "description": "The user ID for the cloud identifier", "length": 255, "name": "userid", "related": "getUser", @@ -153063,30 +153067,30 @@ "related": "", "response": [ { - "description": "the cloud identifier", - "name": "cloudidentifier", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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 signed response for the cloud identifier", + "description": "The signed response for the cloud identifier", "name": "signature", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The User ID for the cloud identifier", + "name": "userid", "type": "string" }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "The cloud identifier", + "name": "cloudidentifier", "type": "string" } ] @@ -153097,146 +153101,146 @@ "name": "createLBStickinessPolicy", "params": [ { - "description": "the description of the load balancer stickiness policy", + "description": "The ID of the load balancer rule", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "param", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", + "description": "Name of the load balancer stickiness policy", "length": 255, - "name": "methodname", + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "The description of the load balancer stickiness policy", "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "name of the load balancer stickiness policy", + "description": "Name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, - "name": "name", + "name": "methodname", "required": true, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "fordisplay", + "name": "param", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" } ], "related": "", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", - "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", + "description": "The state of the policy", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "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 ID of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the list of stickinesspolicies", + "description": "The list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the params of the policy", + "description": "The params of the policy", "name": "params", "type": "map" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "The name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "is policy for display to the regular user", + "description": "Is policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the LB Stickiness policy ID", + "description": "The LB Stickiness policy ID", "name": "id", "type": "string" }, { - "description": "the method name of the Stickiness policy", + "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 state of the policy", + "name": "state", + "type": "string" } ], "type": "list" }, + {}, { - "description": "the state of the policy", - "name": "state", + "description": "The name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "The domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + { + "description": "The description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the domain of the Stickiness policy", + "description": "The domain of the Stickiness policy", "name": "domain", "type": "string" }, - {} + { + "description": "The LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "The Account of the Stickiness policy", + "name": "account", + "type": "string" + } ], "since": "3.0.0" }, @@ -153246,7 +153250,7 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "description": "the Cluster ID", + "description": "The Cluster ID", "length": 255, "name": "clusterid", "related": "addCluster", @@ -153254,7 +153258,7 @@ "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -153281,18 +153285,18 @@ {}, {}, {}, + {}, { - "description": "the UUID of the latest async job acting on 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 status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ] @@ -153303,7 +153307,7 @@ "name": "configurePaloAltoFirewall", "params": [ { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", + "description": "Capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", "length": 255, "name": "fwdevicecapacity", "required": false, @@ -153321,96 +153325,96 @@ "related": "listPaloAltoFirewalls", "response": [ { - "description": "device state", - "name": "fwdevicestate", + "description": "The private interface of the external firewall", + "name": "privateinterface", "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 username that's used to log in to the external firewall", - "name": "username", + "description": "Device ID of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "Device name", + "name": "fwdevicename", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "The public interface of the external firewall", + "name": "publicinterface", + "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", + "description": "The physical Network to which this Palo Alto firewall belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "The username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "The usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "Device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "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 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": "Device capacity", + "name": "fwdevicecapacity", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The 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 public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -153420,35 +153424,21 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "The network of the vm the ACL will be created for", - "length": 255, - "name": "number", - "required": false, - "type": "integer" - }, - { - "description": "the ending port of ACL", + "description": "The starting port of ACL", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, - "type": "string" - }, - { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "protocol", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "An optional field, whether to the display the rule to the end User or not", "length": 255, "name": "fordisplay", "required": false, @@ -153456,39 +153446,32 @@ "type": "boolean" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, - "type": "string" - }, - { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "The ID of the network ACL item", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { - "description": "type of the ICMP message being sent", + "description": "Type of the ICMP message being sent", "length": 255, "name": "icmptype", "required": false, "type": "integer" }, { - "description": "the starting port of ACL", + "description": "Error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "customid", + "name": "reason", "required": false, - "since": "4.4", "type": "string" }, { @@ -153499,147 +153482,117 @@ "type": "boolean" }, { - "description": "the ID of the network ACL item", + "description": "The ending port of ACL", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "The Network of the Instance the ACL will be created for", "length": 255, - "name": "icmpcode", + "name": "number", "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 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" - } - ], - "related": "moveNetworkAclItem", - "response": [ - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "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": "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", + "description": "The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": false, "type": "string" }, - {}, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "ACL entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, "type": "string" - }, + } + ], + "related": "moveNetworkAclItem", + "response": [ { - "description": "the protocol of the ACL", + "description": "The protocol of the ACL", "name": "protocol", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "The list of resource tags associated with the Network ACLs", "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": "Tag value", + "name": "value", "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", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" } @@ -153647,30 +153600,81 @@ "type": "list" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "Type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ACL this item belongs to", + "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": "An explanation on why this ACL rule is being applied", + "name": "reason", + "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": "The ID of the ACL this item belongs to", "name": "aclid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", + "description": "The traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "The name of the ACL this item belongs to", "name": "aclname", "type": "string" + }, + { + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + {}, + { + "description": "The ID of the ACL Item", + "name": "id", + "type": "string" } ] }, @@ -153680,44 +153684,45 @@ "name": "listRouters", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The Zone ID of the router", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "fetchhealthcheckresults", + "name": "projectid", + "related": "", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "list virtual router elements by version", + "description": "The state of the router", "length": 255, - "name": "version", + "name": "state", "required": false, "type": "string" }, { - "description": "the Pod ID of the router", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "The ID of the disk router", "length": 255, - "name": "forvpc", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -153725,42 +153730,50 @@ "type": "uuid" }, { - "description": "the Zone ID of the router", + "description": "The name of the router", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "the host ID of the router", + "description": "The Pod ID of the router", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "podid", + "related": "createManagementNetworkIpRange", "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.", + "description": "If this parameter is passed, list only routers by health check results", "length": 255, - "name": "isrecursive", + "name": "healthchecksfailed", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "List networks by VPC", + "description": "CPU arch of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "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.", @@ -153770,21 +153783,15 @@ "type": "boolean" }, { - "description": "the state of the router", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "If true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "keyword", + "name": "fetchhealthcheckresults", "required": false, - "type": "string" + "since": "4.14", + "type": "boolean" }, { - "description": "list by network id", + "description": "List by network id", "length": 255, "name": "networkid", "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", @@ -153792,364 +153799,465 @@ "type": "uuid" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "List virtual router elements by version", "length": 255, - "name": "healthchecksfailed", + "name": "version", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "the cluster ID of the router", + "description": "The host ID of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "hostid", + "related": "reconnectHost", "required": false, "type": "uuid" }, { - "description": "CPU arch 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": "arch", + "name": "isrecursive", "required": false, - "since": "4.20.1", - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The cluster ID of the router", "length": 255, - "name": "projectid", - "related": "", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "the name of the router", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "If true is passed for this parameter, list only VPC routers", "length": 255, - "name": "page", + "name": "forvpc", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the disk router", + "description": "", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "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 result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "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 project id of the ipaddress", - "name": "projectid", + "description": "The gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain ID associated with the router", + "description": "The domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The Account associated with the router", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "The public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "The project name of the address", + "name": "project", + "type": "string" }, { - "description": "true if the router template requires upgrader", + "description": "True if the router Template requires upgrade", "name": "requiresupgrade", "type": "boolean" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "The Control IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The Zone name for the router", + "name": "zonename", "type": "string" }, + {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "The ID of the corresponding public Network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "The name of the corresponding guest Network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The first IPv6 DNS for the router", + "name": "ip6dns1", "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" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "The guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "True if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the guest MAC address for the router", + "description": "The guest MAC address for the router", "name": "guestmacaddress", "type": "string" }, { - "description": "the template ID for the router", + "description": "The Template ID for the router", "name": "templateid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "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 name of the router", + "name": "name", + "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "The name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "The state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "the Pod ID for the router", + "description": "The Pod ID for the router", "name": "podid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "The date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "The ID of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "The ID of the corresponding guest Network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The ID of the corresponding link local Network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The project id of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "The second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "role of the domain router", + "description": "Role of the domain router", "name": "role", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, + "description": "The guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "The second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "The public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "The link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "The hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The Network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The state of the router", + "name": "state", + "type": "state" + }, + { + "description": "The list of NICs associated with the router", + "name": "nic", + "response": [ { - "description": "Id of the vpc to which the nic belongs", + "description": "ID of the VPC to which the NIC belongs", "name": "vpcid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", + "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 broadcast URI of the NIC", + "name": "broadcasturi", "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": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The traffic type of the NIC", + "name": "traffictype", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The 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", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "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": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the ip address of the nic", + "description": "The IP address of the NIC", "name": "ipaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { @@ -154158,210 +154266,106 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", + "description": "The hypervisor on which the Template runs", "name": "hypervisor", "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "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 second DNS for the router", - "name": "dns2", + "description": "The domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "The Template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "The first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "The host ID for the router", + "name": "hostid", "type": "string" }, { "description": "VPC the router belongs to", "name": "vpcid", "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - {}, - {}, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "result of the health check if available", - "name": "success", - "type": "boolean" - }, - { - "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", - "name": "status", - "type": "routerhealthstatus" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" } ] }, { - "description": "list Tungsten-Fabric vm", + "description": "List Tungsten-Fabric vm", "isasync": false, "name": "listTungstenFabricVm", "params": [ { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "The ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "The uuid of Tungsten-Fabric vm", "length": 255, "name": "vmuuid", "required": false, @@ -154371,26 +154375,25 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric vm name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric nic uuid", @@ -154398,10 +154401,11 @@ "type": "string" }, { - "description": "Tungsten-Fabric vm name", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -154410,7 +154414,7 @@ "name": "deletePhysicalNetwork", "params": [ { - "description": "the ID of the Physical network", + "description": "The ID of the Physical network", "length": 255, "name": "id", "related": "", @@ -154420,42 +154424,35 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "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" }, { - "description": "add Tungsten-Fabric policy rule", + "description": "Add Tungsten-Fabric policy rule", "isasync": true, "name": "addTungstenFabricPolicyRule", "params": [ - { - "description": "Tungsten-Fabric policy rule destination ip prefix", - "length": 255, - "name": "destipprefix", - "required": true, - "type": "string" - }, { "description": "Tungsten-Fabric policy rule destination end port", "length": 255, @@ -154464,35 +154461,35 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source end port", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "srcendport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "srcnetwork", + "name": "srcstartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "action", + "name": "deststartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "policyuuid", + "name": "srcendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -154500,109 +154497,127 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule source ip prefix length", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "srcipprefixlen", + "name": "action", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "protocol", + "name": "destipprefix", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "destnetwork", + "name": "direction", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "srcipprefix", + "name": "destnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "deststartport", + "name": "destipprefixlen", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "The UUID of Tungsten-Fabric policy", "length": 255, - "name": "direction", + "name": "policyuuid", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "destipprefixlen", + "name": "srcipprefixlen", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "srcstartport", + "name": "srcipprefix", "required": true, - "type": "integer" + "type": "string" + }, + { + "description": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", "type": "int" }, - {}, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" }, { "description": "Tungsten-Fabric policy uuid", @@ -154610,20 +154625,19 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, - {}, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "Tungsten-Fabric policy destination start port", @@ -154631,28 +154645,18 @@ "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", "type": "int" } ] @@ -154663,11 +154667,11 @@ "name": "createWebhook", "params": [ { - "description": "Name for the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "sslverification", + "required": false, + "type": "boolean" }, { "description": "State of the Webhook", @@ -154677,17 +154681,10 @@ "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", - "length": 255, - "name": "sslverification", - "required": false, - "type": "boolean" - }, - { - "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", + "description": "Project for the Webhook", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -154699,33 +154696,40 @@ "type": "string" }, { - "description": "Secret key of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "secretkey", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Scope of the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "scope", + "name": "description", "required": false, "type": "string" }, { - "description": "Description for the Webhook", + "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "description", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Secret key of the Webhook", + "length": 255, + "name": "secretkey", "required": false, "type": "string" }, { - "description": "Project for the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "projectid", - "related": "", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Payload URL of the Webhook", @@ -154738,35 +154742,34 @@ "related": "", "response": [ { - "description": "The ID of the Webhook", - "name": "id", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The ID of the Webhook", + "name": "id", + "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, {}, - {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { @@ -154775,23 +154778,29 @@ "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, + {}, + { + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { @@ -154800,54 +154809,50 @@ "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" } ], "since": "4.20.0" }, { - "description": "Removes vpn user", + "description": "Removes VPN User", "isasync": true, "name": "removeVpnUser", "params": [ { - "description": "username for the vpn user", + "description": "Remove VPN User from the project", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "An optional Account for the VPN User. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the VPN User. If the Account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "listDomains", @@ -154855,37 +154860,36 @@ "type": "uuid" }, { - "description": "remove vpn user from the project", + "description": "Username for the VPN User", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" } ], "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -154894,11 +154898,11 @@ "name": "listQuarantinedIps", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Show IPs that are no longer in quarantine.", @@ -154915,11 +154919,11 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -154932,27 +154936,7 @@ "related": "updateQuarantinedIp", "response": [ { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - }, - { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" - }, - { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -154963,8 +154947,13 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" + }, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { @@ -154977,16 +154966,31 @@ "name": "removeraccountid", "type": "string" }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, { "description": "End date for the quarantine.", "name": "enddate", "type": "date" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, {} ], "since": "4.19" @@ -154997,7 +155001,7 @@ "name": "deleteLBHealthCheckPolicy", "params": [ { - "description": "the ID of the load balancer health check policy", + "description": "The ID of the load balancer health check policy", "length": 255, "name": "id", "related": "", @@ -155006,149 +155010,205 @@ } ], "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.2.0" }, { - "description": "List Swift.", - "isasync": false, - "name": "listSwifts", + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", "params": [ { - "description": "List by keyword", + "description": "ID of the host", "length": 255, - "name": "keyword", - "required": false, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "The ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "If host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "The HA state of the host", + "name": "hastate", + "type": "hastate" + }, + {}, + { + "description": "The host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.11" + }, + { + "description": "List Swift.", + "isasync": false, + "name": "listSwifts", + "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the id of the swift", + "description": "The id of the swift", "length": 255, "name": "id", "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" } ], "related": "", "response": [ + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "The URL of the image store", + "name": "url", "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 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 provider name of the image store", - "name": "providername", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "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 Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "The Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the total disk size of the host", + "description": "The total disk size of the host", "name": "disksizetotal", "type": "long" }, { - "description": "the host's currently used disk size", + "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 Zone name of the image store", - "name": "zonename", + "description": "The name of the image store", + "name": "name", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the url of the image store", - "name": "url", + "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", + "description": "The ID of the image store", + "name": "id", "type": "string" } ], "since": "3.0.0" }, { - "description": "Disables HA for a host", + "description": "Enables out-of-band management for a host", "isasync": true, - "name": "disableHAForHost", + "name": "enableOutOfBandManagementForHost", "params": [ { - "description": "ID of the host", + "description": "The ID of the host", "length": 255, "name": "hostid", "related": "reconnectHost", @@ -155159,127 +155219,71 @@ "related": "", "response": [ { - "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", + "description": "True if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, {}, { - "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": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - } - ], - "since": "4.11" - }, - { - "description": "Enables out-of-band management for a host", - "isasync": true, - "name": "enableOutOfBandManagementForHost", - "params": [ - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the out-of-band management driver for the host", + "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 operation result description", + "name": "description", "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": "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", + "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 out-of-band management interface username", + "description": "The out-of-band management interface username", "name": "username", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "The out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "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 action (if issued)", + "description": "The out-of-band management action (if issued)", "name": "action", "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 powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "The out-of-band management interface password", + "name": "password", + "type": "string" }, + {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "The ID of the host", + "name": "hostid", + "type": "string" } ], "since": "4.9.0" @@ -155290,7 +155294,7 @@ "name": "deleteServiceOffering", "params": [ { - "description": "the ID of the service offering", + "description": "The ID of the service offering", "length": 255, "name": "id", "related": "updateServiceOffering,listServiceOfferings", @@ -155300,27 +155304,27 @@ ], "response": [ {}, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "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", + "description": "The 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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -155329,11 +155333,20 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "", + "description": "The ID of the minimum Kubernetes supported version", "length": 255, - "name": "pagesize", + "name": "minimumkubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "The ID of the zone in which Kubernetes supported version will be available", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { "description": "", @@ -155343,30 +155356,28 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "The minimum semantic version for the Kubernetes supported version to be listed", "length": 255, - "name": "keyword", + "name": "minimumsemanticversion", "required": false, "type": "string" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "List by keyword", "length": 255, - "name": "minimumkubernetesversionid", - "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the Kubernetes supported version", + "description": "The ID of the Kubernetes supported version", "length": 255, "name": "id", "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", @@ -155380,107 +155391,105 @@ "required": false, "since": "4.20", "type": "string" - }, - { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", - "length": 255, - "name": "minimumsemanticversion", - "required": false, - "type": "string" } ], "related": "getUploadParamsForKubernetesSupportedVersion", "response": [ { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "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": "The name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "The ID of the Kubernetes supported version", + "name": "id", "type": "string" }, - {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the URL of the binaries ISO for Kubernetes supported version", + "name": "isourl", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "The ID of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "The minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, + {}, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, - {}, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "The date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "The ID of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", - "type": "string" + "description": "Whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "Whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" } ] @@ -155491,17 +155500,10 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, - "type": "string" - }, - { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, + "name": "hostname", + "required": true, "type": "string" }, { @@ -155512,9 +155514,9 @@ "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" }, @@ -155526,7 +155528,7 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -155534,67 +155536,74 @@ "type": "uuid" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "username", - "required": true, + "name": "l3gatewayserviceuuid", + "required": false, + "type": "string" + }, + { + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l2gatewayserviceuuid", + "required": false, "type": "string" } ], "related": "", "response": [ { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Device ID of the Nicire Nvp", + "name": "nvpdeviceid", + "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "The physical Network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "This L2 gateway service UUID", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "Device name", + "name": "niciradevicename", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "This L3 gateway service UUID", + "name": "l3gatewayserviceuuid", "type": "string" }, - {}, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "The transport zone UUID", + "name": "transportzoneuuid", "type": "string" }, - {}, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "The controller IP address", + "name": "hostname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -155605,85 +155614,85 @@ "related": "", "response": [ { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of backup repositories", + "name": "backuprepositories", "type": "integer" }, - {}, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, { - "description": "Number of systemvms", - "name": "systemvms", + "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 pods", + "name": "pods", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, + {}, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of object stores", - "name": "objectstores", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of clusters", - "name": "clusters", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, + {}, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Number of zones", - "name": "zones", + "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": "Number of object stores", + "name": "objectstores", + "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of backup repositories", - "name": "backuprepositories", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" } ], @@ -155695,357 +155704,357 @@ "name": "listUsageRecords", "params": [ { - "description": "List usage records for the specified account", + "description": "End date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", - "required": false, - "type": "uuid" + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "List usage records for specified project", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "projectid", - "related": "", + "name": "includetags", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "startdate", + "required": true, + "type": "date" }, { - "description": "List usage records for the specified domain.", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "oldformat", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "List usage records for specified project", "length": 255, - "name": "includetags", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "List by keyword", "length": 255, - "name": "oldformat", + "name": "keyword", "required": false, - "type": "boolean" - }, - { - "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", - "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "type": "string" }, { - "description": "List usage records for the specified usage type", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "type", + "name": "usageid", "required": false, - "type": "long" + "type": "string" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "List usage records for the specified user.", "length": 255, - "name": "usageid", + "name": "account", "required": false, "type": "string" }, { - "description": "End date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "List usage records for the specified usage type", "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "name": "type", + "required": false, + "type": "long" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "List usage records for the specified account", "length": 255, - "name": "isrecursive", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List usage records for the specified user.", + "description": "List usage records for the specified domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "The user Account ID", + "name": "accountid", "type": "string" }, { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" + "description": "Start date of the usage record", + "name": "startdate", + "type": "date" }, { - "description": "the project name of the resource", - "name": "project", + "description": "The domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "description of the usage record", - "name": "description", - "type": "string" + "description": "Number of CPU of resource", + "name": "cpunumber", + "type": "long" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "Usage in hours", + "name": "usage", "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "Template ID", + "name": "templateid", "type": "string" }, { - "description": "id of the network", - "name": "networkid", + "description": "Instance os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "offering ID", + "description": "Offering ID", "name": "offeringid", "type": "string" }, { - "description": "template ID", - "name": "templateid", + "description": "The project ID of the resource", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the Network", + "name": "networkid", + "type": "string" }, { - "description": "the project id of the resource", - "name": "projectid", + "description": "Description of the usage record", + "name": "description", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" + "description": "Resource or Instance name", + "name": "name", + "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "Instance guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "date" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" }, { - "description": "path of the domain to which the usage reocrd belongs", + "description": "Path of the domain to which the usage reocrd belongs", "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "resource or virtual machine name", - "name": "name", + "description": "Instance ID", + "name": "virtualmachineid", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user account name", + "description": "The user Account name", "name": "account", "type": "string" }, { - "description": "resource size", - "name": "size", + "description": "Memory allocated for the resource", + "name": "memory", "type": "long" }, - {}, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "Usage type ID", + "name": "usagetype", + "type": "integer" + }, + { + "description": "True if the IPAddress is system IP - allocated during Instance deploy or LB rule create", + "name": "issystem", "type": "boolean" }, { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "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": "number of cpu of resource", - "name": "cpunumber", + "description": "Resource size", + "name": "size", "type": "long" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "Resource type", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "The zone ID", + "name": "zoneid", "type": "string" }, { - "description": "end date of the usage record", + "description": "End date of the usage record", "name": "enddate", "type": "date" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" + "description": "Instance os category name", + "name": "oscategoryname", + "type": "string" }, + {}, { - "description": "the domain ID", - "name": "domainid", - "type": "string" + "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": "Speed of each CPU of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "Raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "usage in hours", - "name": "usage", + "description": "The domain ID", + "name": "domainid", "type": "string" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "ID of the resource", + "name": "usageid", "type": "string" }, { - "description": "the user account Id", - "name": "accountid", - "type": "string" + "description": "Virtual size of resource", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "Instance os display name", + "name": "osdisplayname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the VPC", + "name": "vpcid", "type": "string" } ] @@ -156067,54 +156076,49 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "Cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "The Instance'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", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The bytes allocated", + "name": "virtualsize", + "type": "long" }, { "description": "ID of the service offering for root disk", @@ -156122,126 +156126,68 @@ "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Display name of the Instance", + "name": "vmdisplayname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, - {}, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the bytes actually consumed on disk", + "description": "The bytes actually consumed on disk", "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "The disk utilization", + "name": "utilization", + "type": "string" }, { - "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -156250,204 +156196,277 @@ "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "The ID of the device on User Instance the volume is attached 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": "Min IOPS of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The chain info of the volume", + "name": "chaininfo", "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": "the domain associated with the disk volume", - "name": "domain", - "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 Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "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": "the status of the volume", - "name": "status", + "description": "ID of the Snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, + {}, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The project id of the VPN", + "name": "projectid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "The display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "An optional field whether to the display the volume to the end User or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the date the disk volume was created", + "description": "Name of the Instance", + "name": "vmname", + "type": "string" + }, + { + "description": "The date the disk volume was created", "name": "created", "type": "date" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the Instance", + "name": "virtualmachineid", "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": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "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 name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "The date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The status of the volume", + "name": "status", + "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "Size of the disk volume", + "name": "size", + "type": "long" }, + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, - {}, { - "description": "state of the virtual machine", + "description": "State of the Instance", "name": "vmstate", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The project name of the VPN", + "name": "project", "type": "string" }, { @@ -156456,57 +156475,40 @@ "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Shared or local storage", + "name": "storagetype", "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": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" } ], "since": "4.14.0" }, { - "description": "remove Tungsten-Fabric network gateway from logical router", + "description": "Remove Tungsten-Fabric network gateway from logical router", "isasync": true, "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ { - "description": "Tungsten-Fabric logical router uuid", - "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -156519,20 +156521,39 @@ "name": "networkuuid", "required": true, "type": "string" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "list Tungsten-Fabric policy network name", + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "List Tungsten-Fabric policy network name", "name": "network", "type": "list" }, + {}, + {}, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", @@ -156544,22 +156565,10 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" - }, - {} + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -156577,7 +156586,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -156588,6 +156597,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the ID of the storage pool", "length": 255, @@ -156595,27 +156611,35 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ + { + "description": "name of the primary storage hosting the volume", + "name": "storage", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, { "description": "the format of the volume", "name": "format", "type": "string" }, { - "description": "the full path of the volume", - "name": "fullpath", + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" }, + { + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the path of the volume", "name": "path", @@ -156626,25 +156650,31 @@ "name": "storageid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" }, + { + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" + }, {}, { - "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 current status of the latest async job acting on this object", + "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": "the full path of the volume", + "name": "fullpath", "type": "string" }, { @@ -156653,30 +156683,9 @@ "type": "long" }, { - "description": "volume details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "name of the primary storage hosting the volume", - "name": "storage", - "type": "string" - }, - {}, - { - "description": "the encrypt format of the volume", - "name": "encryptformat", - "type": "string" - }, - { - "description": "type of the primary storage hosting the volume", - "name": "storagetype", + "description": "the name of the volume", + "name": "name", "type": "string" - }, - { - "description": "the virtual size of the volume", - "name": "virtualsize", - "type": "long" } ], "since": "4.19.1" @@ -156687,50 +156696,47 @@ "name": "listZonesMetrics", "params": [ { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "The ID of the zone", "length": 255, - "name": "ids", + "name": "id", "related": "listZones", "required": false, - "since": "4.19.0", - "type": "list" + "type": "uuid" }, { - "description": "flag to display the capacity of the zones", + "description": "List by keyword", "length": 255, - "name": "showcapacities", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "The Network type of the zone that the Instance belongs to", "length": 255, "name": "networktype", "required": false, "type": "string" }, { - "description": "the ID of the zone", + "description": "The name of the zone", "length": 255, - "name": "id", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the storage access group", + "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 Instance. Default is false.", "length": 255, - "name": "storageaccessgroup", + "name": "available", "required": false, - "since": "4.21.0", - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "Flag to display the resource image for the zones", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -156740,262 +156746,268 @@ "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" }, { - "description": "the ID of the domain associated with the zone", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ids", + "related": "listZones", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "list" }, { - "description": "List by keyword", + "description": "The ID of the domain associated with the zone", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the name of the storage access group", "length": 255, - "name": "tags", + "name": "storageaccessgroup", "required": false, - "since": "4.3", - "type": "map" + "since": "4.21.0", + "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "Flag to display the capacity of the zones", "length": 255, - "name": "showicon", + "name": "showcapacities", "required": false, "type": "boolean" }, { - "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": "", "length": 255, - "name": "available", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "", "response": [ { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "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 total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "The total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "Zone Token", + "name": "zonetoken", "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", + "response": [ + { + "description": "The Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "The Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "The Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "The Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "The percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "The capacity name", + "name": "name", + "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 Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "The capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The Pod ID", + "name": "podid", + "type": "string" + } + ], + "type": "list" }, { - "description": "External network provider if any", - "name": "provider", + "description": "The type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "The first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "CPU allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "True, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "The Network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "Healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "The list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity name", - "name": "name", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "Resource type", + "name": "resourcetype", + "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 Pod name", - "name": "podname", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "Used GPUs in the Zone", - "name": "gpuused", + "description": "Total GPUs in the Zone", + "name": "gputotal", "type": "long" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "The guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + {}, + { + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", + "description": "True, if zone contains clusters and hosts from different CPU architectures", "name": "ismultiarch", "type": "boolean" }, { - "description": "Zone name", - "name": "name", + "description": "The second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "The maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { @@ -157004,188 +157016,175 @@ "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" + "description": "State of the cluster", + "name": "state", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "Memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "Memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "True if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "The UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "CPU usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "CPU allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "The maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "The display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "The DHCP Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "True if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "healthy / total clusters in the zone", - "name": "clusters", + "description": "The total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "CPU usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, - {}, { - "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": "AS Number Range", - "name": "asnrange", + "description": "Memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "The name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "The total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "The first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "The total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "Memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "The second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "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": "The maximum value the MTU can have on the VR's public interfaces", @@ -157193,34 +157192,37 @@ "type": "integer" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "The second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "True, if routed Network/VPC is enabled", + "name": "routedmodeenabled", "type": "boolean" + }, + { + "description": "The first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" } ], "since": "4.9.3" }, { - "description": "Extracts a template", + "description": "Extracts a Template", "isasync": true, "name": "extractTemplate", "params": [ { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, - { - "description": "the url to which the ISO would be extracted", + "description": "The url to which the ISO would be extracted", "length": 2048, "name": "url", "required": false, "type": "string" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "The ID of the zone where the ISO is originally located", "length": 255, "name": "zoneid", "related": "listZones", @@ -157228,25 +157230,27 @@ "type": "uuid" }, { - "description": "the ID of the template", + "description": "The ID of the Template", "length": 255, "name": "id", "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" + }, + { + "description": "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" } ], "related": "extractSnapshot", "response": [ { - "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": "", @@ -157254,110 +157258,115 @@ "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" - }, - { - "description": "the time and date the object was created", + "description": "The time and date the object was created", "name": "created", "type": "date" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "The ID of extracted object", + "name": "id", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "The percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, - {}, { - "description": "type of the storage", + "description": "Type of the storage", "name": "storagetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "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 name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "The mode of extraction - upload or download", + "name": "extractMode", "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": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "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 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 mode of extraction - upload or download", - "name": "extractMode", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "The upload ID of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "The state of the extracted object", + "name": "state", + "type": "string" + } ] }, { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", + "description": "Expunge an Instance. Once expunged, it cannot be recovered.", "isasync": true, "name": "expungeVirtualMachine", "params": [ { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "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", + "description": "The 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" - }, - {}, {} ] }, @@ -157367,15 +157376,15 @@ "name": "updateIpAddress", "params": [ { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the public IP address to update", + "description": "The ID of the public IP address to update", "length": 255, "name": "id", "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", @@ -157383,302 +157392,302 @@ "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 IP to the end User or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "public IP address", - "name": "ipaddress", + "description": "The domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "The virtual Network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The ID of the Network where IP belongs to", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VPC name the IP belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "The name of the Network where IP belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "True if the IP address is a source NAT address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + {}, + { + "description": "Instance display name the IP address is assigned to (not null only for static NAT IP)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "Public IP address ID", + "name": "id", + "type": "string" + }, + { + "description": "The project id of the IP address", + "name": "projectid", + "type": "string" + }, + { + "description": "Instance (DNAT) IP address (not null only for static NAT IP)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, + { + "description": "The name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "description": "VPC ID the IP belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "True if this IP is system IP (was allocated as a part of deployVm or createLbRule)", "name": "issystem", "type": "boolean" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "The domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "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", - "name": "networkname", + "description": "Instance name the IP address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "Instance id the IP address is assigned to", + "name": "virtualmachineid", "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": "VPC id the ip belongs to", - "name": "vpcid", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "Instance type the IP address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "The ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "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 ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "The name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "Date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the list of resource tags associated with ip address", + "description": "The list of resource tags associated with IP address", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag key name", - "name": "key", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, - {}, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "description": "Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined", "name": "hasrules", "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "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 range is dedicated for external network providers", - "name": "forprovider", + "description": "Is public IP for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "the account the public IP address is associated with", + "description": "The Account the public IP address is associated with", "name": "account", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "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": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "Is public IP portable across the zones", + "name": "isportable", "type": "boolean" - }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" } ] }, { - "description": "moves a network to another physical network", + "description": "Moves a network to another physical network", "isasync": true, "name": "migrateNetwork", "params": [ { - "description": "the ID of the network", + "description": "Network offering ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "networkofferingid", + "related": "", "required": true, "type": "uuid" }, { - "description": "true if previous network migration cmd failed", + "description": "True if previous network migration cmd failed", "length": 255, "name": "resume", "required": false, "type": "boolean" }, { - "description": "network offering ID", + "description": "The ID of the network", "length": 255, - "name": "networkofferingid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" } @@ -157686,538 +157695,545 @@ "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "Display text of the Network offering the Network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The displaytext of the Network", + "name": "displaytext", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "List Networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "True if Network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "The details of the Network", + "name": "details", + "type": "map" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "ACL ID associated with the VPC Network", + "name": "aclid", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "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 Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The VLAN of the Network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The project ID of the IP address", + "name": "projectid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "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": "The physical Network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The destination physical Network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "The provider name", + "name": "name", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "Name of the Network offering the Network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The domain ID of the Network owner", + "name": "domainid", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "VPC the Network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "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", + "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 owner of the Network", + "name": "account", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "The first IPv4 DNS for the Network", + "name": "dns1", + "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "Tungsten-Fabric virtual router the Network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "True if users from subdomains can access the domain level Network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "Path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "If Network offering supports Instance autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "The IPv6 routing type 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 name of the zone the Network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "Name of the VPC to which this Network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The traffic type of the Network", + "name": "traffictype", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "If the Network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "The Network's netmask", + "name": "netmask", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The internet protocol of Network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "The project name of the address", + "name": "project", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "True if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "An optional field, whether to the display the Network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "True if Network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Broadcast URI of the Network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the network", + "description": "The name of the Network", "name": "name", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "State of the Network", + "name": "state", + "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "True if Network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "True if Network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "acl type - access type to the network", + "description": "ACL type - access type to the Network", "name": "acltype", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "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": "the project name of the address", - "name": "project", + "description": "The type of the Network", + "name": "type", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "The Network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "The list of resource tags associated with Network", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The 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": "id of the resource", - "name": "resourceid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "The ID of the Network", + "name": "id", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "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 supports specifying IP ranges, false otherwise", + "name": "specifyipranges", "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 ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "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": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "MTU configured on the Network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Broadcast domain type of the Network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - {}, - { - "description": "the network's netmask", - "name": "netmask", + "description": "The second IPv4 DNS for the Network", + "name": "dns2", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The external ID of the Network", + "name": "externalid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The Network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The routes for the Network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "The first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The physical Network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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", + "description": "True if guest Network default egress policy is allow; false if default egress policy is deny", "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "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" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "ACL name associated with the VPC Network", + "name": "aclname", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Availability of the Network offering the Network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "True if Network offering is IP conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "List Networks available for Instance deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" } ], "since": "4.11.0" }, { - "description": "Lists unmanaged virtual machines for a given cluster.", + "description": "Lists unmanaged Instances 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, @@ -158233,48 +158249,47 @@ "type": "integer" }, { - "description": "the hypervisor name of the instance", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the cluster ID", + "description": "The cluster ID", "length": 255, "name": "clusterid", "related": "addCluster", "required": true, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "The operating system of the Instance", + "name": "osdisplayname", + "type": "string" }, + {}, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "The ID of the host to which Instance belongs", + "name": "hostid", + "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", + "description": "The name of the host to which Instance belongs", "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The ID of the cluster to which Instance belongs", + "name": "clusterid", "type": "string" }, { @@ -158283,14 +158298,71 @@ "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "The list of disks associated with the Instance", + "name": "disk", + "response": [ + { + "description": "The capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "The controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "The controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "The file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "The controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "The controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "The controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "The position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "The label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "The controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "The ID of the disk", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" + "description": "The CPU speed of the Instance", + "name": "cpuspeed", + "type": "integer" }, { "description": "indicates the boot mode", @@ -158298,72 +158370,57 @@ "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the list of nics associated with the virtual machine", + "description": "The list of NICs associated with the Instance", "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The ID of the NIC", + "name": "id", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The netmask of the NIC", + "name": "netmask", + "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 ID of the corresponding Network", + "name": "networkid", "type": "string" }, { @@ -158372,48 +158429,63 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "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 type of the nic", - "name": "type", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "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 netmask of the nic", - "name": "netmask", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { @@ -158422,303 +158494,256 @@ "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", + "description": "Id of the Instance to which the NIC belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" } ], "type": "set" }, { - "description": "indicates the 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 ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "The CPU cores of the Instance", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "The CPU cores per socket for the Instance. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "The hypervisor version of the host to which Instance belongs", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The operating system ID of the Instance", + "name": "osid", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - } - ], - "type": "set" + "description": "The hypervisor to which Instance belongs", + "name": "hypervisor", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The memory of the Instance in MB", + "name": "memory", "type": "integer" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "The power state of the Instance", + "name": "powerstate", "type": "string" }, {}, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.14.0" }, { - "description": "Registers an existing template into the CloudStack cloud.", + "description": "Registers an existing Template into the CloudStack cloud.", "isasync": false, "name": "registerTemplate", "params": [ { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "(VMware only) true if Instance deployments should preserve all the configurations defined for this Template", "length": 255, - "name": "isdynamicallyscalable", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "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": "True if the Template supports the sshkey upload feature; default is false", "length": 255, - "name": "checksum", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Register template for the project", + "description": "The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template", "length": 255, - "name": "projectid", + "name": "ostypeid", "related": "", "required": false, "type": "uuid" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory", "length": 255, - "name": "deployasis", + "name": "isdynamicallyscalable", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "The tag for this Template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, + { + "description": "The target hypervisor for the Template", "length": 255, "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "The ID of the zone the Template is to be hosted on", "length": 255, - "name": "arch", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.20", - "type": "string" + "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "True if the Template is available to all accounts; default is true", "length": 255, - "name": "isextractable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "An optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "externaldetails", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.21.0", - "type": "map" + "type": "uuid" + }, + { + "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 type is routing i.e., if template is used to deploy router", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "isrouting", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the tag for this template.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "templatetag", + "name": "templatetype", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "True if the Template type is routing i.e., if Template is used to deploy router", "length": 255, - "name": "forcks", + "name": "isrouting", "required": false, - "since": "4.21.0", "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "ostypeid", - "related": "", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "ID of the extension", + "description": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "account", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, + "description": "The display text of the Template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the name of the template", + "description": "The name of the Template", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "directdownload", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "ispublic", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "32 or 64 bits support. 64 by default", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "bits", + "name": "externaldetails", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "map" }, { "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", @@ -158728,68 +158753,62 @@ "type": "map" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "an optional accountName. Must be used with domainId.", + "description": "True if this Template is a featured Template, false otherwise", "length": 255, - "name": "account", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "ID of the extension", "length": 255, - "name": "templatetype", + "name": "extensionid", + "related": "listExtensions", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "checksum", "required": false, - "type": "uuid" + "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": "Register Template for the project", "length": 255, - "name": "zoneids", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "true if this template requires HVM", + "description": "True if this Template requires HVM", "length": 255, "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs to be registered to multiple zones in one go. Use zoneid if the Template needs to be registered to only one zone.Passing only -1 to this will cause the Template to be registered as a cross zone Template and will be copied to all zones. ", "length": 255, - "name": "isfeatured", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "True if the Template supports the password reset feature; default is false", "length": 255, "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "True if the Template or its derivatives are extractable; default is false", "length": 255, - "name": "directdownload", + "name": "isextractable", "required": false, "type": "boolean" } @@ -158797,212 +158816,192 @@ "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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": "Path of the Domain the template belongs to", + "name": "domainpath", "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": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "True if Template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "The Template name", + "name": "name", "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", + "description": "Checksum of the Template", + "name": "checksum", "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 list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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 domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "The processor bit size", + "name": "bits", + "type": "int" }, { - "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 processor bit size", - "name": "bits", - "type": "int" + "description": "The Account name to which the Template belongs", + "name": "account", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "The Template display text", + "name": "displaytext", + "type": "string" }, {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "The type of the Template", + "name": "templatetype", + "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The ID of the OS type for this Template.", + "name": "ostypeid", "type": "string" }, { @@ -159011,144 +159010,164 @@ "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "The project name of the Template", + "name": "project", + "type": "string" }, { - "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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the template 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 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": "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 secondary storage host for the Template", + "name": "hostname", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "The Template ID of the parent Template if present", + "name": "sourcetemplateid", "type": "string" }, - {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "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 id to which the template belongs", - "name": "accountid", + "description": "The name of the OS type for this Template.", + "name": "ostypename", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "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 name of extension linked to this template", - "name": "extensionname", + "description": "The id of userdata linked to this Template", + "name": "userdataid", "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 URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The ID of the secondary storage host for the Template", + "name": "hostid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Lists the download progress of a Template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "True if 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 Template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "The physical size of the Template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "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 this template is a public template, false otherwise", - "name": "ispublic", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "VMware only: additional key/value details tied with deploy-as-is Template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "The name of userdata linked to this Template", + "name": "userdataname", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The ID of the zone for this Template", + "name": "zoneid", "type": "string" }, { - "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", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" } ] @@ -159159,40 +159178,39 @@ "name": "listVnfAppliances", "params": [ { - "description": "the security group ID", + "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "gpuenabled", "required": false, - "since": "4.15", - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled", "length": 255, - "name": "userid", - "related": "getUser", + "name": "haenable", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by Network ID", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "List Instances by affinity group", "length": 255, - "name": "backupofferingid", + "name": "affinitygroupid", "related": "", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the availability zone ID", + "description": "The availability zone ID", "length": 255, "name": "zoneid", "related": "listZones", @@ -159200,119 +159218,113 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of AutoScaling VM Group", + "description": "The group ID", "length": 255, - "name": "autoscalevmgroupid", + "name": "groupid", "related": "", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Makes the API's response contains only the resource count", "length": 255, - "name": "displayvm", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "description": "Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "gpuenabled", + "name": "details", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "list" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "Whether to return the Instances' User data or not. By default, User data will not be returned.", "length": 255, - "name": "haenable", + "name": "userdata", "required": false, - "since": "4.15", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "list vms by ssh keypair name", + "description": "The ID of the Instance", "length": 255, - "name": "keypair", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "List Instances by SSH keypair name", "length": 255, - "name": "state", + "name": "keypair", "required": false, "type": "string" }, { - "description": "list vms by affinity group", + "description": "List by the backup offering", "length": 255, - "name": "affinitygroupid", + "name": "backupofferingid", "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "CPU arch of the VM", + "description": "List by the service offering", "length": 255, - "name": "arch", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.20.1", - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "List Instances by ISO", "length": 255, - "name": "name", + "name": "isoid", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "The ID of AutoScaling Instance Group", "length": 255, - "name": "isvnf", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "since": "4.19.0", - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "details", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "list vms by vpc", + "description": "Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Whether to return only leased instances", @@ -159323,126 +159335,125 @@ "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the instances by userdata", "length": 255, - "name": "projectid", + "name": "userdataid", "related": "", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "List by Network type; true if need to list Instances using Virtual Network, false otherwise", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "CPU arch of the VM", "length": 255, - "name": "keyword", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "list vms by template", + "description": "Flag to display the resource icon for Instances", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" + }, + { + "description": "The user ID that created the Instance and is under the Account that owns the Instance", + "length": 255, + "name": "userid", + "related": "getUser", "required": false, "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "forvirtualnetwork", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the group ID", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "groupid", - "related": "", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "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.", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "accumulate", + "name": "isvnf", "required": false, - "since": "4.17.0", + "since": "4.19.0", "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", + "description": "The target hypervisor for the Template", "length": 255, - "name": "showicon", + "name": "hypervisor", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "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": "displayvm", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "list by the service offering", + "description": "", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "page", "required": false, - "since": "4.4", - "type": "uuid" + "type": "integer" }, { - "description": "list vms by iso", + "description": "", "length": 255, - "name": "isoid", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "The IDs of the Instances, mutually exclusive with id", "length": 255, "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "since": "4.4", "type": "list" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "Accumulates the Instance 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": "userdata", + "name": "accumulate", "required": false, - "since": "4.18.0.0", + "since": "4.17.0", "type": "boolean" }, { @@ -159455,51 +159466,174 @@ "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "List Instances by VPC", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the instances by userdata", + "description": "List Instances by Template", "length": 255, - "name": "userdataid", - "related": "", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "since": "4.20.1", "type": "uuid" }, { - "description": "list by network id", + "description": "State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "state", "required": false, + "type": "string" + }, + { + "description": "The security group ID", + "length": 255, + "name": "securitygroupid", + "related": "", + "required": false, + "since": "4.15", "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "OS type id of the vm", + "description": "OS type id of the Instance", "name": "ostypeid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" + }, + { + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Guest Instance Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "The name of userdata used for the Instance", + "name": "userdataname", + "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 Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The vGPU type used by the Instance", + "name": "vgpu", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { "description": "the maximum number of display heads", @@ -159507,1134 +159641,1024 @@ "type": "long" }, { - "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 Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The group name of the Instance", + "name": "group", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "The state of the Instance", + "name": "state", + "type": "string" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + {}, + { + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "The project name of the Instance", + "name": "project", + "type": "string" + }, + { + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The date when this Instance was created", + "name": "created", + "type": "date" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "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 IPv6 address of network", - "name": "ip6address", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The netmask of the NIC", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The ID of the NIC", + "name": "id", + "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "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 netmask of the nic", - "name": "netmask", + "description": "The IPv6 address of Network", + "name": "ip6address", "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 traffic type of the nic", - "name": "traffictype", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", + "description": "The name of the ISO attached to the Instance", "name": "isoname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 account owning the affinity group", + "description": "The Account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "Resource type", + "name": "resourcetype", + "type": "string" } ], "type": "set" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, + {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "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 type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the 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 VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "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": "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "list of security groups associated with the virtual machine", + "description": "List of security groups associated with the Instance", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "The Account owning the security group", + "name": "account", + "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 name of the security group", + "name": "name", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", + "description": "The number of Instances associated with this Security Group", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "The domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "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", + "description": "The type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the code for the ICMP message 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", + "description": "Account owning the security group rule", + "name": "account", + "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 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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The 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 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": "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 domain associated with the tag", - "name": "domain", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" } ], "type": "set" - }, + } + ], + "type": "set" + }, + { + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "Account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", + "description": "The starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "The code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", + "description": "The ID of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", + "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", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag 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": "Tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The 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 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": "security group name", + "description": "Security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "The protocol of the security group rule", + "name": "protocol", "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "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", + "description": "The project id of the group", "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag 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": "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": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "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 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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "SSH key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", + "description": "The name of the service offering of the Instance", "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, - {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + {}, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" } ], @@ -160646,14 +160670,21 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp api name", + "description": "Stratosphere ssp API username", "length": 255, - "name": "name", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the zone ID", + "description": "Stratosphere ssp API password", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "The zone ID", "length": 255, "name": "zoneid", "related": "listZones", @@ -160661,66 +160692,59 @@ "type": "uuid" }, { - "description": "stratosphere ssp tenant uuid", + "description": "Stratosphere ssp server URL", "length": 255, - "name": "tenantuuid", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "Stratosphere ssp API name", "length": 255, - "name": "password", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "stratosphere ssp api username", + "description": "Stratosphere ssp tenant UUID", "length": 255, - "name": "username", + "name": "tenantuuid", "required": false, "type": "string" - }, - { - "description": "stratosphere ssp server url", - "length": 255, - "name": "url", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "zone which this ssp controls", + "description": "Zone which this ssp controls", "name": "zoneid", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Server ID of the stratosphere ssp server", + "name": "hostid", "type": "string" }, { - "description": "url of ssp endpoint", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "URL of ssp endpoint", "name": "url", "type": "string" }, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "Name", + "name": "name", "type": "string" }, + {}, { - "description": "name", - "name": "name", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -160731,100 +160755,101 @@ "name": "createStoragePool", "params": [ { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the cluster ID 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": "clusterid", - "related": "addCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the tags for the storage pool", + "description": "The tags for the storage pool", "length": 255, "name": "tags", "required": false, "type": "string" }, { - "description": "whether the storage should be managed by CloudStack", + "description": "Whether the storage should be managed by CloudStack", "length": 255, "name": "managed", "required": false, "type": "boolean" }, { - "description": "the Zone ID for the storage pool", + "description": "The cluster ID for the storage pool", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "clusterid", + "related": "addCluster", + "required": false, "type": "uuid" }, { - "description": "the storage provider name", + "description": "The details for the storage pool", "length": 255, - "name": "provider", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", "length": 255, - "name": "capacityiops", + "name": "storageaccessgroups", "required": false, - "type": "long" + "since": "4.21.0", + "type": "string" }, { - "description": "the details for the storage pool", + "description": "The name for the storage pool", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "Bytes CloudStack can provision from this storage pool", "length": 255, - "name": "hypervisor", + "name": "capacitybytes", "required": false, - "type": "string" + "type": "long" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "capacitybytes", + "name": "capacityiops", "required": false, "type": "long" }, { - "description": "the scope of the storage: cluster or zone", + "description": "The scope of the storage: cluster or zone", "length": 255, "name": "scope", "required": false, "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "The storage provider name", "length": 255, - "name": "istagarule", + "name": "provider", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name for the storage pool", + "description": "The URL of the storage pool", "length": 255, - "name": "name", + "name": "url", "required": true, "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "The Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The Pod ID for the storage pool", "length": 255, "name": "podid", "related": "createManagementNetworkIpRange", @@ -160832,65 +160857,53 @@ "type": "uuid" }, { - "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "storageaccessgroups", + "name": "istagarule", "required": false, - "since": "4.21.0", - "type": "string" + "type": "boolean" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "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 scope of the storage pool", - "name": "scope", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "The IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, - {}, { - "description": "the pool's currently used disk size", - "name": "disksizeused", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "The Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the storage pool details", - "name": "details", + "description": "The storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "The storage pool type", + "name": "type", "type": "string" }, { @@ -160898,110 +160911,95 @@ "name": "capacitybytes", "type": "long" }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "True if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "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 storage pool was created", + "name": "created", + "type": "date" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "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 pool's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "The state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "The tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "The Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "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 overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "The Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -161010,19 +161008,45 @@ "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "The pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" + }, + { + "description": "The ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "The scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -161046,214 +161070,214 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the volume", + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "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": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", - "type": "long" + "description": "The Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the pool's currently allocated disk size", + "description": "The pool's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "The storage pool type", + "name": "type", "type": "string" }, - {}, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "The tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "The scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "The overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "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 ID of the storage pool", - "name": "id", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the 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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the date and time the storage pool was created", + "description": "The date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "The total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "Total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "The name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The 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", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "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 details", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "The ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "The ID of the storage pool", + "name": "id", "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 Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "The IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", + "description": "the storage pool details", + "name": "details", "type": "map" } ] }, { - "description": "delete Tungsten-Fabric firewall rule", + "description": "Delete Tungsten-Fabric firewall rule", "isasync": true, "name": "deleteTungstenFabricFirewallRule", "params": [ { - "description": "the ID of zone", + "description": "The ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -161261,7 +161285,7 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "The uuid of Tungsten-Fabric firewall rule", "length": 255, "name": "firewallruleuuid", "required": true, @@ -161269,32 +161293,32 @@ } ], "response": [ + {}, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the 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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True 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": "disable a Cisco Nexus VSM device", + "description": "Disable a Cisco Nexus VSM device", "isasync": true, "name": "disableCiscoNexusVSM", "params": [ @@ -161310,74 +161334,74 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "Device name", + "name": "vsmdevicename", "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": "management vlan id of the VSM", + "description": "Management VLAN ID of the VSM", "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" + "description": "Storage VLAN ID of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, - {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "Device ID of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, + {}, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "Device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "device state", - "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": "Packet VLAN ID of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "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", + "description": "Control VLAN ID of the VSM", + "name": "vsmctrlvlanid", "type": "int" }, {} @@ -161389,107 +161413,107 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the netmask for storage network", + "description": "The ending IP address", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { - "description": "UUID of pod where the ip range belongs to", + "description": "Optional. The VLAN the IP range sits on, default to Null when it is not specified which means your network is not on any VLAN. This is mainly for VMware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "integer" }, { - "description": "the gateway for storage network", + "description": "The gateway for storage network", "length": 255, "name": "gateway", "required": true, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "ID of pod where the IP range belongs to", "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the beginning IP address", + "description": "The netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the ending IP address", + "description": "The starting IP address", "length": 255, - "name": "endip", - "required": false, + "name": "startip", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "The end IP of the storage Network IP range", + "name": "endip", "type": "string" }, + {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "The gateway of the storage Network IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "The Network UUID of storage Network IP range", + "name": "networkid", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", + "description": "The Zone UUID of the storage Network IP range", "name": "zoneid", "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 netmask of the storage network IP range", - "name": "netmask", + "description": "The UUID of storage Network IP range.", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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 start IP of the storage Network IP range", + "name": "startip", + "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", + "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 netmask of the storage Network IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" + "description": "The ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" } ], "since": "3.0.0" @@ -161500,79 +161524,79 @@ "name": "configureOvsElement", "params": [ { - "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" }, { - "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" } ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "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 id of the ovs", + "description": "The ID of the ovs", "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", + "description": "The project ID of the IP address", "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "The domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "The domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the provider", + "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 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" } ] }, @@ -161582,18 +161606,19 @@ "name": "listSystemVmsUsageHistory", "params": [ { - "description": "", + "description": "End date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "The ID of the system VM.", "length": 255, - "name": "startdate", + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "date" + "type": "uuid" }, { "description": "List by keyword", @@ -161603,146 +161628,145 @@ "type": "string" }, { - "description": "", + "description": "The IDs of the System VMs, mutually exclusive with ID.", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "integer" + "type": "list" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "enddate", + "name": "name", "required": false, - "type": "date" + "type": "string" }, { - "description": "the ID of the system VM.", + "description": "Start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", + "description": "The ID of the Instance", "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Name of the Instance", + "name": "name", "type": "string" }, { - "description": "the list of VM stats", + "description": "The list of Instance stats", "name": "stats", "response": [ { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", + "name": "timestamp", + "type": "date" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the amount of downloaded data by the VM in MiB", - "name": "networkread", + "description": "The amount of uploaded data by the Instance in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", - "name": "diskioread", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount (percentage) of the VM's CPU currently used", + "description": "The amount (percentage) of the Instance's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "The memory used by the Instance in KB", + "name": "memorykbs", "type": "long" }, { - "description": "the total disk iops since the last stats retrieval", - "name": "diskiopstotal", + "description": "The Instance's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the amount of uploaded data by the VM in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "the time when the VM stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", - "name": "timestamp", - "type": "date" + "description": "The total disk IOPS since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", - "name": "diskiowrite", + "description": "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskioread", "type": "long" }, { - "description": "the memory used by the VM in KB", - "name": "memorykbs", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the target memory in VM (KB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The amount of downloaded data by the Instance in MiB", + "name": "networkread", + "type": "string" }, { - "description": "the VM's free memory in KB or -1 if it cannot be gathered", - "name": "memoryintfreekbs", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "The target memory in Instance (KB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", "type": "long" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", + "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": "User generated name. The name of the Instance 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" }, {} @@ -161755,7 +161779,7 @@ "name": "deleteIpv6FirewallRule", "params": [ { - "description": "the ID of the IPv6 firewall rule", + "description": "The ID of the IPv6 firewall rule", "length": 255, "name": "id", "related": "", @@ -161765,27 +161789,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The 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" + } ] }, { @@ -161794,64 +161818,64 @@ "name": "createFirewallRule", "params": [ { - "description": "the ending port of firewall rule", + "description": "The starting port of firewall rule", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the starting port of firewall rule", + "description": "Error code for this icmp message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, "name": "cidrlist", "required": false, "type": "list" }, { - "description": "the IP address id of the port forwarding rule", + "description": "The protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "type of firewallrule: system/user", + "description": "The ending port of firewall rule", "length": 255, - "name": "type", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "The IP address ID of the port forwarding rule", "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "type of the ICMP message being sent", + "description": "Type of the ICMP message being sent", "length": 255, "name": "icmptype", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "An optional field, whether to the display the rule to the end User or not", "length": 255, "name": "fordisplay", "required": false, @@ -161862,345 +161886,384 @@ "related": "updateEgressFirewallRule", "response": [ { - "description": "the starting port of firewall rule's port range", + "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": "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", + "description": "The state of the rule", + "name": "state", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the public ip address for the firewall rule", + "description": "The public IP address for the firewall rule", "name": "ipaddress", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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 value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "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", + "description": "The protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "The public IP address ID for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "Type of the ICMP message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "Error code for this ICMP message", + "name": "icmpcode", + "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", + "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", + "description": "The ending port of firewall rule's port range", "name": "endport", "type": "integer" - }, - {} + } ] }, { - "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to an Instance to make use of it.", "isasync": true, "name": "createVolume", "params": [ { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "The project associated with the volume. Mutually exclusive with Account parameter", "length": 255, - "name": "diskofferingid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "min iops", + "description": "The ID of the availability zone", "length": 255, - "name": "miniops", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "Arbitrary volume size", "length": 255, - "name": "displayvolume", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "description": "Max IOPS", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "maxiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The Account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "customid", + "name": "account", "required": false, "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": "", + "name": "snapshotid", + "related": "listSnapshots", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "The name of the disk volume", "length": 255, "name": "name", "required": false, "type": "string" }, { - "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.If account is NOT provided then the volume will be assigned to the caller Account and domain.", "length": 255, - "name": "size", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "An optional field, whether to display the volume to the end User or not.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "displayvolume", + "required": false, + "type": "boolean" + }, + { + "description": "Storage pool ID to create the volume in. Cannot be used with the snapshotid parameter.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,enableStorageMaintenance", "required": false, "type": "uuid" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "description": "The ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "snapshotid", - "related": "listSnapshots", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "Min IOPS", "length": 255, - "name": "account", + "name": "miniops", "required": false, - "type": "string" + "type": "long" }, { - "description": "the ID of the availability zone", + "description": "The ID of the Instance; to be used with snapshot Id, Instance to which the volume gets attached after creation", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "max iops", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "maxiops", + "name": "customid", "required": false, - "type": "long" + "type": "string" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "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": "the status of the volume", - "name": "status", - "type": "string" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "The state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "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.", + "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": "Bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "True if storage Snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, { - "description": "the current status of the latest async job acting on this object", + "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 ID of the Template for the Instance. A -1 is returned if the Instance 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": "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": "Name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the primary storage hosting the disk volume; returned to admin User only", + "name": "storageid", + "type": "string" }, - {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The project name of the VPN", + "name": "project", "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 bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "The name of the Template for the Instance", + "name": "templatename", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "The project id of the VPN", + "name": "projectid", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "The chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + {}, + { + "description": "The disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -162209,381 +162272,342 @@ "type": "string" }, { - "description": "the date the disk volume was created", + "description": "Max IOPS of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "The date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the list of resource tags associated", + "description": "Display name of the Instance", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Volume UUID that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "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 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": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", + "description": "Tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "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 ID of the 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": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", "type": "long" }, { - "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 Instance the volume is attached 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": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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 state of the disk volume", - "name": "state", + "description": "Type of the Instance", + "name": "vmtype", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The Account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "The path of the volume", + "name": "path", "type": "string" }, { - "description": "pod name of the volume", + "description": "Pod name of the volume", "name": "podname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Name of the Instance", + "name": "vmname", "type": "string" }, - {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "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 date the volume was attached to an Instance", + "name": "attached", + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "The boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The status of the volume", + "name": "status", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "Min IOPS of the disk volume", + "name": "miniops", "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 display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "The bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "Cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "State of the Instance", + "name": "vmstate", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "Name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Provisioning type used to create volumes.", + "name": "provisioningtype", "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": "true if volume has delete protection.", - "name": "deleteprotection", - "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", + "description": "The bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "Need quiesce Instance or not when taking Snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", + "description": "The Instance'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": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" } ] }, { - "description": "List virtual machine snapshot by conditions", + "description": "List Instance Snapshot by conditions", "isasync": false, "name": "listVMSnapshot", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The ID of the VM snapshot", + "description": "", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the Instance", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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 snapshot by snapshot name or display name", + "description": "State of the Instance Snapshot", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "state of the virtual machine snapshot", + "description": "Lists Snapshot by Snapshot name or display name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, @@ -162602,27 +162626,36 @@ "type": "boolean" }, { - "description": "", + "description": "The ID of the Instance Snapshot", "length": 255, - "name": "pagesize", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the vm", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid", + "length": 255, + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "since": "4.9", + "type": "list" }, { "description": "", @@ -162632,18 +162665,17 @@ "type": "integer" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "projectid", + "related": "", "required": false, - "since": "4.9", - "type": "list" + "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" } @@ -162651,389 +162683,389 @@ "related": "createVMSnapshot", "response": [ { - "description": "VM Snapshot type", - "name": "type", + "description": "Indicates if this is current Snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "The ID of the Instance Snapshot", + "name": "id", "type": "string" }, - {}, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "The state of the Instance Snapshot", + "name": "state", + "type": "state" + }, + { + "description": "The create date of the Instance Snapshot", + "name": "created", + "type": "date" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", + "description": "The type of hypervisor on which Snapshot is stored", "name": "hypervisor", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The parent ID of the Instance Snapshot", + "name": "parent", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The display name of the Instance Snapshot", + "name": "displayname", + "type": "string" + }, + {}, + { + "description": "The Zone name of the Instance Snapshot", + "name": "zonename", + "type": "string" + }, + { + "description": "The domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "The Account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "The Instance name of the Instance Snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "Path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Instance Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "The description of the Instance Snapshot", + "name": "description", + "type": "string" + }, + { + "description": "The name of the Instance Snapshot", + "name": "name", + "type": "string" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The Instance ID of the Instance Snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "The project name of the VPN", + "name": "project", + "type": "string" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "The project ID of the VPN", + "name": "projectid", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "The Zone ID of the Instance Snapshot", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "The parent displayName of the Instance Snapshot", + "name": "parentName", "type": "string" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Move an ACL rule to a position between two other ACL rules of the same ACL Network list", + "isasync": true, + "name": "moveNetworkAclItem", + "params": [ { - "description": "the description of the vm snapshot", - "name": "description", + "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 Zone ID of the vm snapshot", - "name": "zoneid", + "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 account associated with the disk volume", - "name": "account", + "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 state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "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 Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "Type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "Error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "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 name of the vm snapshot", - "name": "name", + "description": "The traffic type for the ACL", + "name": "traffictype", "type": "string" }, - {}, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "The ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "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 first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", - "length": 255, - "name": "previousaclruleid", - "required": false, + "description": "The starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", - "length": 255, - "name": "nextaclruleid", - "required": false, + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, + "description": "The ID of the ACL Item", "name": "id", - "required": true, - "type": "string" - }, - { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", - "length": 255, - "name": "aclconsistencyhash", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", "type": "string" }, - {}, - {}, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "The protocol of the ACL", + "name": "protocol", "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 list of resource tags associated with the network ACLs", + "description": "The list of resource tags associated with the Network ACLs", "name": "tags", "response": [ { - "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": "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": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", + "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": "tag key name", + "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": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "the state of the rule", + "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": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Disassociates an IP address from the account.", + "description": "Disassociates an IP address from the Account.", "isasync": true, "name": "disassociateIpAddress", "params": [ @@ -163046,7 +163078,7 @@ "type": "string" }, { - "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", + "description": "The ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "length": 255, "name": "id", "related": "associateIpAddress,listPublicIpAddresses", @@ -163055,49 +163087,41 @@ } ], "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", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", + "description": "True 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": "list baremetal dhcp servers", + "description": "List baremetal dhcp servers", "isasync": false, "name": "listBaremetalDhcp", "params": [ { - "description": "Type of DHCP device", + "description": "", "length": 255, - "name": "dhcpservertype", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -163113,6 +163137,13 @@ "required": false, "type": "integer" }, + { + "description": "Type of DHCP device", + "length": 255, + "name": "dhcpservertype", + "required": false, + "type": "string" + }, { "description": "DHCP server device ID", "length": 255, @@ -163121,50 +163152,51 @@ "type": "long" }, { - "description": "", + "description": "The Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "name of the provider", - "name": "dhcpservertype", + "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" }, { - "description": "device id of ", - "name": "id", + "description": "Name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "URL", + "name": "url", "type": "string" }, + {}, { - "description": "the physical network to which this external dhcp device belongs to", + "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": "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": "dhcpservertype", "type": "string" } ] @@ -163186,187 +163218,187 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "The storage pool type", + "name": "type", "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "total min IOPS currently in use by volumes", + "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": "The ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "The tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "Storage provider for this pool", - "name": "provider", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "bytes CloudStack can provision from this storage pool", - "name": "capacitybytes", + "description": "The pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "The IP address of the storage pool", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "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 state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "The Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "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", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "The scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the pool's currently allocated disk size", - "name": "disksizeallocated", + "description": "The pool's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", + "description": "the storage pool details", + "name": "details", "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the storage pool details", - "name": "details", + "description": "The Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, + {}, { - "description": "true if the entity/resource has annotations", + "description": "True if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "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", + "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 name of the storage pool", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -163385,32 +163417,32 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" }, { - "description": "lists all available apis on the server, provided by the Api Discovery plugin", + "description": "Lists all available APIs on the server, provided by the API Discovery plugin", "isasync": false, "name": "listApis", "params": [ @@ -163424,123 +163456,123 @@ ], "related": "", "response": [ + {}, { - "description": "the list params the api accepts", + "description": "The list params the api accepts", "name": "params", "response": [ { - "description": "length of the parameter", - "name": "length", - "type": "int" + "description": "Version of CloudStack the API was introduced in", + "name": "since", + "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "Parameter type", + "name": "type", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "True if this parameter is required for the API request", + "name": "required", + "type": "boolean" + }, + { + "description": "Comma separated related APIs to get the parameter", + "name": "related", "type": "string" }, { - "description": "description of the api parameter", + "description": "Length of the parameter", + "name": "length", + "type": "int" + }, + { + "description": "Description of the API parameter", "name": "description", "type": "string" }, { - "description": "parameter type", - "name": "type", + "description": "The name of the API parameter", + "name": "name", "type": "string" }, - {}, + {} + ], + "type": "set" + }, + { + "description": "API response fields", + "name": "response", + "response": [ { - "description": "the name of the api parameter", + "description": "The name of the API response field", "name": "name", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "Description of the API response field", + "name": "description", + "type": "string" + }, + { + "description": "Response field type", + "name": "type", + "type": "string" + }, + { + "description": "API response fields", + "name": "response", + "type": "set" } ], "type": "set" }, { - "description": "comma separated related apis", - "name": "related", - "type": "string" - }, - { - "description": "response field type", + "description": "Response field type", "name": "type", "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 name of the api command", + "description": "The name of the API command", "name": "name", "type": "string" }, - {}, { - "description": "true if api is asynchronous", + "description": "True if API is asynchronous", "name": "isasync", "type": "boolean" }, { - "description": "description of the api", - "name": "description", + "description": "Comma separated related apis", + "name": "related", "type": "string" }, { - "description": "api response fields", - "name": "response", - "response": [ - { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "api response fields", - "name": "response", - "type": "set" - }, - { - "description": "the name of the api response field", - "name": "name", - "type": "string" - }, - { - "description": "description of the api response field", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Version of CloudStack the API was introduced in", "name": "since", "type": "string" - } + }, + {} ], "since": "4.1.0" }, { - "description": "deletes baremetal rack configuration text", + "description": "Deletes baremetal rack configuration text", "isasync": true, "name": "deleteBaremetalRct", "params": [ @@ -163555,67 +163587,67 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, { - "description": "Creates snapshot for a vm.", + "description": "Creates Snapshot for an Instance.", "isasync": true, "name": "createVMSnapshot", "params": [ { - "description": "snapshot memory if true", + "description": "The ID of the Instance", "length": 255, - "name": "snapshotmemory", - "required": false, - "type": "boolean" + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "The display name of the snapshot", + "description": "Quiesce Instance if true", "length": 255, - "name": "name", + "name": "quiescevm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "quiesce vm if true", + "description": "Snapshot memory if true", "length": 255, - "name": "quiescevm", + "name": "snapshotmemory", "required": false, "type": "boolean" }, { - "description": "The ID of the vm", + "description": "The description of the Snapshot", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "The description of the snapshot", + "description": "The display name of the Snapshot", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" } @@ -163623,188 +163655,188 @@ "related": "", "response": [ { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "The description of the Instance Snapshot", + "name": "description", + "type": "string" + }, + { + "description": "The create date of the Instance Snapshot", + "name": "created", + "type": "date" + }, + { + "description": "The ID of the Instance Snapshot", + "name": "id", + "type": "string" + }, + { + "description": "The name of the Instance Snapshot", + "name": "name", + "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 display name of the vm snapshot", - "name": "displayname", + "description": "The parent displayName of the Instance Snapshot", + "name": "parentName", "type": "string" }, { - "description": "the state of the vm snapshot", + "description": "The state of the Instance Snapshot", "name": "state", "type": "state" }, { - "description": "the list of resource tags associated", + "description": "The Zone ID of the Instance Snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "Instance Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "The Account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "The project name of the VPN", + "name": "project", + "type": "string" + }, + { + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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 Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "The Instance name of the Instance Snapshot", + "name": "virtualmachinename", "type": "string" }, {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The parent ID of the Instance Snapshot", + "name": "parent", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "The domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "The ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The Instance ID of the Instance Snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "indicates if this is current snapshot", + "description": "Indicates if this is current Snapshot", "name": "current", "type": "boolean" }, { - "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": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "Path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "The type of hypervisor on which Snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone name of the vm snapshot", + "description": "The Zone name of the Instance Snapshot", "name": "zonename", "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The display name of the Instance Snapshot", + "name": "displayname", "type": "string" - }, - { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ], "since": "4.2.0" @@ -163815,7 +163847,7 @@ "name": "deleteLoadBalancer", "params": [ { - "description": "the ID of the Load Balancer", + "description": "The ID of the Load Balancer", "length": 255, "name": "id", "related": "", @@ -163825,26 +163857,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", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "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" + }, {} ], "since": "4.2.0" @@ -163854,10 +163886,18 @@ "isasync": false, "name": "listTungstenFabricTagType", "params": [ + { + "description": "The ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -163869,7 +163909,7 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag type", + "description": "The uuid of Tungsten-Fabric tag type", "length": 255, "name": "tagtypeuuid", "required": false, @@ -163878,52 +163918,44 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" } ] }, @@ -163933,19 +163965,19 @@ "name": "extractSnapshot", "params": [ { - "description": "the ID of the snapshot", + "description": "the ID of the zone where the snapshot is located", "length": 255, - "name": "id", - "related": "listSnapshots", + "name": "zoneid", + "related": "listZones", "required": true, "since": "4.20.0", "type": "uuid" }, { - "description": "the ID of the zone where the snapshot is located", + "description": "the ID of the snapshot", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "listSnapshots", "required": true, "since": "4.20.0", "type": "uuid" @@ -163954,87 +163986,87 @@ "related": "", "response": [ { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "The Account ID to which the extracted object belongs", + "name": "accountid", + "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "Type of the storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "Zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "The upload ID of extracted object", + "name": "extractId", "type": "string" }, - {}, { - "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", - "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", + "description": "The time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "The status of the extraction", + "name": "status", "type": "string" }, + {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "The ID of extracted object", + "name": "id", "type": "string" }, { - "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": "Zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "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 name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "The mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "", + "name": "resultstring", "type": "string" - }, - {} + } ], "since": "4.20.0" }, @@ -164044,22 +164076,29 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", + "required": false, + "type": "string" + }, + { + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, @@ -164073,26 +164112,19 @@ "type": "integer" }, { - "description": "A public key fingerprint to look for", - "length": 255, - "name": "fingerprint", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "The ID of the SSH keypair", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "A key pair name to look for", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -164102,12 +164134,11 @@ "type": "boolean" }, { - "description": "the ID of the ssh keypair", + "description": "", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -164117,72 +164148,73 @@ "type": "string" }, { - "description": "A key pair name to look for", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "ID of the ssh keypair", - "name": "id", + "description": "The project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the SSH keypair", + "name": "id", + "type": "string" }, { "description": "Name of the keypair", "name": "name", "type": "string" }, - {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "The owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "The domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "The project name of the keypair owner", + "name": "project", "type": "string" }, + {}, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "The domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -164191,7 +164223,7 @@ "name": "cancelStorageMaintenance", "params": [ { - "description": "the primary storage ID", + "description": "The primary storage ID", "length": 255, "name": "id", "related": "cancelStorageMaintenance", @@ -164202,196 +164234,204 @@ "related": "", "response": [ { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "The Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "The pool'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": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the pool's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The Zone name of the storage pool", + "name": "zonename", + "type": "string" }, - {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "The storage pool path", + "name": "path", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "Total min IOPS currently in use by volumes", + "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 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 ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "The pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "The tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool capabilities", + "description": "True if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "The storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, + {}, { - "description": "the storage pool type", - "name": "type", + "description": "The ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, - { - "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": "bytes CloudStack can provision from this storage pool", "name": "capacitybytes", "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "The date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "The Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "The IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The storage pool type", + "name": "type", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "The scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "The name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - { - "description": "the pool's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "description": "the storage pool custom stats", "name": "storagecustomstats", "type": "map" }, { - "description": "the name of the storage pool", + "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 scope of the storage pool", - "name": "scope", - "type": "string" + "description": "The state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the hypervisor type of the storage pool", + "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": "Updates the snapshot policy.", + "description": "Updates the Snapshot policy.", "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", + "description": "An optional field, whether to the display the Snapshot policy to the end user or not.", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, "name": "customid", "required": false, @@ -164399,115 +164439,129 @@ "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "The ID of the Snapshot policy", "length": 255, "name": "id", "related": "updateSnapshotPolicy", "required": false, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "the name of the disk volume", - "name": "volumename", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "The ID of the Snapshot policy", + "name": "id", + "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", + "description": "Time the Snapshot is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "maximum number of snapshots retained", + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" + }, + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "Maximum number of Snapshots retained", "name": "maxsnaps", "type": "int" }, { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" + "description": "Is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "The time zone of the Snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag 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 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": "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 ID of the domain associated with the tag", + "description": "The ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" } @@ -164515,65 +164569,43 @@ "type": "set" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "The list of pools in which snapshot backup is scheduled", - "name": "storage", - "type": "set" + "description": "The interval type of the Snapshot policy", + "name": "intervaltype", + "type": "short" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" } ] }, { - "description": "Lists balance and quota usage for all accounts", + "description": "Lists balance and quota usage for all Accounts", "isasync": false, "name": "quotaSummary", "params": [ { - "description": "Optional, to list all accounts irrespective of the quota activity", + "description": "Optional, to list all Accounts irrespective of the quota activity", "length": 255, "name": "listall", "required": false, "type": "boolean" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -164600,71 +164632,71 @@ "related": "", "response": [ { - "description": "account name", - "name": "account", - "type": "string" + "description": "Quota usage of this period", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "Account balance", + "name": "balance", + "type": "bigdecimal" + }, + { + "description": "Start date", + "name": "startdate", + "type": "date" }, { - "description": "account state", + "description": "Account state", "name": "state", "type": "state" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain name", + "name": "domain", "type": "string" }, { - "description": "end date", - "name": "enddate", - "type": "date" - }, - { - "description": "currency", + "description": "Currency", "name": "currency", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "domain id", - "name": "domainid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "if the account has the quota config enabled", + "description": "If the account has the quota config enabled", "name": "quotaenabled", "type": "boolean" }, + {}, { - "description": "quota usage of this period", - "name": "quota", - "type": "bigdecimal" - }, - { - "description": "domain name", - "name": "domain", + "description": "Account name", + "name": "account", "type": "string" }, { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" + "description": "End date", + "name": "enddate", + "type": "date" }, + {}, { - "description": "start date", - "name": "startdate", - "type": "date" + "description": "Domain ID", + "name": "domainid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Account ID", + "name": "accountid", + "type": "string" } ], "since": "4.7.0" @@ -164675,106 +164707,122 @@ "name": "queryAsyncJobResult", "params": [ { - "description": "the ID of the asynchronous job", + "description": "The ID of the asynchronous job", "length": 255, "name": "jobid", "related": "queryAsyncJobResult", - "required": true, + "required": false, "type": "uuid" + }, + { + "description": "the type of the resource associated with the job", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.22.1", + "type": "string" + }, + { + "description": "the ID of the resource associated with the job", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.22.1", + "type": "string" } ], "related": "", "response": [ { - "description": "the account that executed the async command", - "name": "account", + "description": "The domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "description": "The User that executed the async command", + "name": "userid", "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "The result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The async command executed", + "name": "cmd", "type": "string" }, { - "description": "the account id that executed the async command", + "description": "The Account ID that executed the async command", "name": "accountid", "type": "string" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "The progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "The result code for the job", + "name": "jobresultcode", + "type": "integer" + }, + { + "description": "The MSID of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "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", + "name": "account", + "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "The result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "The Instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "The completed date of the job", + "name": "completed", + "type": "date" }, - {}, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" + "description": "The created date of the job", + "name": "created", + "type": "date" }, { - "description": "the async command executed", - "name": "cmd", + "description": "The unique ID of the Instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, {}, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "The domain ID that executed the async command", + "name": "domainid", + "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ] @@ -164785,23 +164833,23 @@ "name": "registerNetscalerControlCenter", "params": [ { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "password", "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" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -164816,125 +164864,125 @@ "related": "addNetscalerLoadBalancer", "response": [ { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "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 physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "The management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "device state", + "description": "Device state", "name": "lbdevicestate", "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": "the public interface of the load balancer", - "name": "publicinterface", + "description": "Private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "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": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "Device name", + "name": "lbdevicename", "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "Name of the provider", + "name": "provider", "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 UUID of the latest async job acting on this object", + "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": "Device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "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 to be a GSLB service provider", - "name": "gslbprovider", + "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": "Public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "Device ID of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" } ] }, { - "description": "Adds metric counter for VM auto scaling", + "description": "Adds metric counter for Instance auto scaling", "isasync": true, "name": "createCounter", "params": [ { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Source of the counter.", "length": 255, - "name": "value", + "name": "source", "required": true, "type": "string" }, { - "description": "Network provider of the counter.", + "description": "Name of the counter.", "length": 255, - "name": "provider", + "name": "name", "required": true, - "since": "4.18.0", "type": "string" }, { - "description": "Source of the counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "source", + "name": "provider", "required": true, + "since": "4.18.0", "type": "string" }, { - "description": "Name of the counter.", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "name", + "name": "value", "required": true, "type": "string" } @@ -164942,45 +164990,45 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "Source of the counter.", + "name": "source", "type": "string" }, {}, { - "description": "zone id of counter", - "name": "zoneid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Source of the counter.", - "name": "source", + "description": "The ID of the Counter", + "name": "id", "type": "string" }, - {}, { "description": "Provider of the counter.", "name": "provider", "type": "string" }, + {}, { - "description": "the id of the Counter", - "name": "id", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Zone ID of counter", + "name": "zoneid", "type": "string" } ] @@ -164992,23 +165040,23 @@ "params": [], "related": "", "response": [ - { - "description": "Event Type", - "name": "name", - "type": "string" - }, {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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": "Event Type", + "name": "name", "type": "string" }, - {} + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -165017,7 +165065,7 @@ "name": "prepareForShutdown", "params": [ { - "description": "the id of the management server", + "description": "The UUID of the management server", "length": 255, "name": "managementserverid", "related": "", @@ -165027,27 +165075,27 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The id of the management server", + "name": "managementserverid", "type": "string" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", @@ -165058,27 +165106,27 @@ "name": "agentscount", "type": "long" }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Indicates whether maintenance has been initiated", "name": "maintenanceinitiated", "type": "boolean" }, - { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" - }, { "description": "the state of the management server", "name": "state", "type": "state" }, - {} + {}, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + } ], "since": "4.19.0" }, @@ -165088,78 +165136,76 @@ "name": "addCluster", "params": [ { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "The username for the cluster", "length": 255, - "name": "clustertype", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the URL", + "description": "The username for the VSM associated with this cluster", "length": 255, - "name": "url", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "vsmipaddress", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "arch", + "name": "guestvswitchname", "required": false, - "since": "4.20", "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "The URL", "length": 255, - "name": "ovm3pool", + "name": "url", "required": false, "type": "string" }, { - "description": "UUID of the extension", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "publicvswitchname", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "Type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "vsmpassword", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "UUID of the extension", "length": 255, - "name": "guestvswitchname", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the username for the cluster", + "description": "Hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", "length": 255, - "name": "username", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "The cluster name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clustername", "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)", @@ -165169,33 +165215,25 @@ "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "allocationstate", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", + "description": "The password for the host", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", - "length": 255, - "name": "guestvswitchtype", + "name": "password", "required": false, "type": "string" }, { - "description": "comma separated list of storage access groups for the hosts in the cluster", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "storageaccessgroups", + "name": "ovm3vip", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { "description": "Ovm3 native OCFS2 clustering enabled for cluster", @@ -165205,53 +165243,63 @@ "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "The Pod ID for the host", "length": 255, - "name": "ovm3vip", + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "The IP address of the VSM associated with this cluster", + "length": 255, + "name": "vsmipaddress", "required": false, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", "length": 255, - "name": "vsmusername", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "the password for the host", + "description": "The CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "password", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", + "description": "comma separated list of storage access groups for the hosts in the cluster", "length": 255, - "name": "externaldetails", + "name": "storageaccessgroups", "required": false, "since": "4.21.0", - "type": "map" + "type": "list" }, { - "description": "the cluster name", + "description": "The Zone ID for the cluster", "length": 255, - "name": "clustername", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID for the host", + "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": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "guestvswitchtype", + "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 VSM associated with this cluster", "length": 255, - "name": "publicvswitchname", + "name": "vsmpassword", "required": false, "type": "string" } @@ -165259,134 +165307,114 @@ "related": "", "response": [ { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "The cluster name", + "name": "name", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "Whether this cluster is managed by Cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the Zone ID of the cluster", + "description": "The Zone ID of the cluster", "name": "zoneid", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The Pod name of the cluster", + "name": "podname", "type": "string" }, - {}, { - "description": "the Pod ID of the cluster", + "description": "The Pod ID of the cluster", "name": "podid", "type": "string" }, {}, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "The CPU overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "The allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { "description": "The name of extension for this cluster", "name": "extensionname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the capacity of the Cluster", + "description": "The capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "The capacity name", + "name": "name", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster name", + "description": "The Cluster name", "name": "clustername", "type": "string" }, @@ -165396,51 +165424,71 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "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 Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in use", + "description": "The capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "The Zone name", + "name": "zonename", "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", + "description": "The percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], "type": "list" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "The cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -165466,31 +165514,31 @@ ], "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", + "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": "Removes VM from specified network by deleting a NIC", + "description": "Removes Instance from specified network by deleting a NIC", "isasync": true, "name": "removeNicFromVirtualMachine", "params": [ @@ -165503,539 +165551,771 @@ "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "Instance ID", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The incoming Network traffic on the Instance 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 project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The group ID of the Instance", + "name": "groupid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", + "description": "The name of userdata used for the Instance", "name": "userdataname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS name of the Instance", + "name": "osdisplayname", "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": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "The type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "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 host for the virtual machine", + "description": "The name of the host for the Instance", "name": "hostname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The ID of userdata used for the Instance", + "name": "userdataid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The User's ID who deployed the Instance", + "name": "userid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "Instance details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The User's name who deployed the Instance", + "name": "username", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "List of security groups associated with the Instance", + "name": "securitygroup", + "response": [ + { + "description": "The description of the security group", + "name": "description", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The 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 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": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The project name of the group", + "name": "project", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The 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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The ID of the security group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Tag key name", + "name": "key", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - {}, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The name of the Instance", + "name": "name", "type": "string" }, { @@ -166044,614 +166324,291 @@ "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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", + "description": "The password (if exists) of the Instance", + "name": "password", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "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 userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The list of NICs associated with Instance", + "name": "nic", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "IP addresses associated with NIC found for unmanaged Instance", + "name": "ipaddresses", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "True if NIC is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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 gateway of the NIC", + "name": "gateway", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "The name of the corresponding Network", + "name": "networkname", + "type": "string" + }, + { + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The ID of the NIC", "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" - } - ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "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 account owning the security group", - "name": "account", + "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "ID of the VPC to which the NIC belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "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 id of the group", - "name": "projectid", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", "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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "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": "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" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 type of the NIC", + "name": "type", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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" - } - ], - "type": "set" + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", "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": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "the name of the template for the virtual machine", + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "The name of the Template for the Instance", "name": "templatename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The state of the Instance", + "name": "state", "type": "string" }, { @@ -166660,14 +166617,110 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" + }, + { + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" + }, + { + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + {}, + { + "description": "The ID of the host for the Instance", + "name": "hostid", + "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 group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" + }, + { + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } ] }, @@ -166677,21 +166730,21 @@ "name": "listDedicatedHosts", "params": [ { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "The name of the account associated with the host. 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 host", + "description": "The ID of the domain associated with the host", "length": 255, "name": "domainid", "related": "listDomains", @@ -166699,15 +166752,14 @@ "type": "uuid" }, { - "description": "the ID of the host", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list dedicated hosts by affinity group", + "description": "List dedicated hosts by affinity group", "length": 255, "name": "affinitygroupid", "related": "", @@ -166715,162 +166767,163 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "The ID of the host", "length": 255, - "name": "page", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the Account ID of the host", - "name": "accountid", + "description": "The ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "The Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "hostname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest 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 host", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The Account ID of the host", + "name": "accountid", "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 Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "The name of the host", + "name": "hostname", "type": "string" }, - {} + { + "description": "The ID of the host", + "name": "hostid", + "type": "string" + } ] }, { - "description": "upload an existing ISO into the CloudStack cloud.", + "description": "Upload an existing ISO into the CloudStack cloud.", "isasync": false, "name": "getUploadParamsForIso", "params": [ { - "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 format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "format", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "true if you want this ISO to be featured", + "description": "True if you want this ISO to be featured", "length": 255, "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "True if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", - "length": 255, - "name": "bootable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the name of the volume/template/iso", + "description": "The name of the Volume/Template/ISO", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", + "description": "The display text of the ISO. This is usually used for display purposes.", "length": 4096, "name": "displaytext", "required": false, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "True if you want to register the ISO to be publicly available to all Users, false otherwise.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ispublic", "required": false, + "type": "boolean" + }, + { + "description": "The ID of the zone the Volume/Template/ISO is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "Upload volume/template/iso for the project", + "description": "The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "projectid", + "name": "ostypeid", "related": "", "required": false, "type": "uuid" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "isextractable", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "An optional domainId. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "ostypeid", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Upload Volume/Template/ISO for the project", + "length": 255, + "name": "projectid", "related": "", "required": false, "type": "uuid" @@ -166878,53 +166931,53 @@ ], "related": "", "response": [ + {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "POST url to upload the file to", "name": "postURL", "type": "url" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "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", + "description": "The Template/volume ID", + "name": "id", + "type": "uuid" + }, + { + "description": "The timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "encrypted data to be sent in the POST request.", + "description": "Encrypted data to be sent in the POST request.", "name": "metadata", "type": "string" }, - {}, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - {} + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.13" }, { - "description": "Get diagnostics and files from system VMs", + "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", + "description": "The ID of the System VM to retrieve diagnostics data files from", "length": 255, "name": "targetid", "related": "", @@ -166943,31 +166996,31 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Storage URL to download retrieve diagnostics data files", "name": "url", "type": "string" }, - {} + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.14.0.0" }, { - "description": "Deletes a autoscale vm group.", + "description": "Deletes an autoscale Instance group.", "isasync": true, "name": "deleteAutoScaleVmGroup", "params": [ { - "description": "true if all VMs have to be cleaned up, false otherwise", + "description": "True if all VMs have to be cleaned up, false otherwise", "length": 255, "name": "cleanup", "required": false, @@ -166975,7 +167028,7 @@ "type": "boolean" }, { - "description": "the ID of the autoscale group", + "description": "The ID of the autoscale group", "length": 255, "name": "id", "related": "", @@ -166984,58 +167037,58 @@ } ], "response": [ + {}, + {}, { - "description": "any text associated with the success or failure", + "description": "Any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "True 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", + "description": "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 Palo Alto firewall devices in a physical network", + "description": "Lists Palo Alto firewall devices in a physical Network", "isasync": false, "name": "listPaloAltoFirewalls", "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -167054,95 +167107,95 @@ "related": "", "response": [ { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The zone ID of the external firewall", + "name": "zoneid", "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 username that's used to log in to the external firewall", + "description": "The username that's used to log in to the external firewall", "name": "username", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "The private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "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 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", + "description": "The private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "device capacity", + "description": "Device capacity", "name": "fwdevicecapacity", "type": "long" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "The public security zone of the external firewall", + "name": "publiczone", "type": "string" }, {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "Device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "The management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "device name", + "description": "Device name", "name": "fwdevicename", "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 public security zone of the external firewall", - "name": "publiczone", + "description": "Device ID of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "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": "The physical Network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "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" } ] @@ -167153,14 +167206,14 @@ "name": "updateLoadBalancerRule", "params": [ { - "description": "The protocol for the LB", - "length": 255, - "name": "protocol", + "description": "The description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -167168,22 +167221,14 @@ "type": "boolean" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": false, - "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The protocol for the LB", "length": 255, - "name": "customid", + "name": "protocol", "required": false, - "since": "4.4", "type": "string" }, { - "description": "the ID of the load balancer rule to update", + "description": "The ID of the load balancer rule to update", "length": 255, "name": "id", "related": "", @@ -167191,17 +167236,11 @@ "type": "uuid" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "the name of the load balancer rule", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { @@ -167211,187 +167250,201 @@ "required": false, "since": "4.22", "type": "list" - } - ], - "related": "listLoadBalancerRules", - "response": [ - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "description": "Load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, "name": "algorithm", + "required": false, "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "The name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "listLoadBalancerRules", + "response": [ { - "description": "the id of the guest network the lb rule belongs to", + "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", + "description": "The project ID of the Load balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "the list of resource tags associated with load balancer", + "description": "The list of resource tags associated with Load balancer", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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 domain associated with the tag", - "name": "domain", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Tag 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": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "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": "Resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "The domain of the Load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "The name of the Load balancer", + "name": "name", + "type": "string" + }, + {}, + { + "description": "The project name of the Load balancer", + "name": "project", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "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 ID of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public port", + "description": "The public port", "name": "publicport", "type": "string" }, + { + "description": "The name of the zone the Load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The description of the Load balancer", + "name": "description", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "The protocol of the Load Balancer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "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", + "type": "string" + }, + {}, + { + "description": "The domain ID of the Load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "The Load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "The Account of the Load balancer rule", + "name": "account", "type": "string" } ] @@ -167402,7 +167455,15 @@ "name": "enableAccount", "params": [ { - "description": "Enables specified account.", + "description": "Enables specified Account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Enables specified Account.", "length": 255, "name": "account", "required": false, @@ -167415,348 +167476,245 @@ "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": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "The total number of CPU cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "The total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, + {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "The total number of Instances that can be deployed by this Account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "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": "true if account is default, false otherwise", + "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": "The total number of public IP addresses this Account can acquire", + "name": "iplimit", + "type": "string" }, + {}, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "The name of the Account", + "name": "name", "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 being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "The total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "The total number of Instances available for this Account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "The total number of projects available for administration by this Account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "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": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "The total number of Instances deployed by this Account", + "name": "vmtotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, - {}, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "The total number of Networks the Account can own", + "name": "networklimit", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "ID of the Domain the Account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "The ID of the Account", + "name": "id", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "The total number of Snapshots which can be stored by this Account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "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 buckets which can be stored by this account", - "name": "bucketlimit", + "description": "The total volume available for this Account", + "name": "volumeavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "The total number of VPCs the Account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "The total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "The total number of Networks owned by Account", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "Name of the Domain the Account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "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 CPU cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "The total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "The total number of Templates which can be created by this Account", + "name": "templatelimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "The total number of Snapshots available for this Account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", + "description": "The total number of public IP addresses available for this Account to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "The total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the network domain", + "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 list of ACL groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" + "description": "The total number of CPU cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "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 total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "The total number of Instances stopped for this Account", + "name": "vmstopped", "type": "integer" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", - "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 public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "the name of the role", - "name": "rolename", - "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", - "type": "string" - }, - { - "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" }, { @@ -167765,63 +167723,48 @@ "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "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", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "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 date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the list of users associated with account", + "description": "The list of users associated with account", "name": "user", "response": [ { - "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", + "description": "The date and time the user Account was created", "name": "created", "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "The domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The type of the role", + "name": "roletype", "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 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", @@ -167829,122 +167772,232 @@ "type": "resourceiconresponse" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "The name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", + "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 Account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user email address", - "name": "email", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { - "description": "the ID of the role", + "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 domain name of the user", - "name": "domain", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user state", + "description": "The user state", "name": "state", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the user ID", + "description": "The user ID", "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The user name", + "name": "username", + "type": "string" + }, + { + "description": "The user lastname", + "name": "lastname", "type": "string" + }, + { + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ], "type": "list" }, { - "description": "the state of the account", - "name": "state", + "description": "Path of the Domain the Account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The total volume which can be used by this Account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", + "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 backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "The total number of Networks available to be created for this Account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "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 total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The total number of Instances running for this Account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "The ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "Account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "The total number of Templates available to be created by this Account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "The total number of VPCs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "The total volume being used by this Account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "The default zone of the Account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" + }, + { + "description": "The total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The state of the account", + "name": "state", + "type": "string" } ] }, @@ -167953,6 +168006,13 @@ "isasync": true, "name": "changeStoragePoolScope", "params": [ + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": true, + "type": "string" + }, { "description": "the Id of the cluster to use if scope is being set to Cluster", "length": 255, @@ -167961,13 +168021,6 @@ "required": false, "type": "uuid" }, - { - "description": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": true, - "type": "string" - }, { "description": "the Id of the storage pool", "length": 255, @@ -167978,26 +168031,26 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest 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" } ], @@ -168019,24 +168072,24 @@ ], "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 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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } @@ -168044,49 +168097,49 @@ "since": "4.21.0" }, { - "description": "Deletes a network", + "description": "Deletes a Network", "isasync": true, "name": "deleteNetwork", "params": [ { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the network", + "description": "The ID of the network", "length": 255, "name": "id", "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" + }, + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "response": [ { - "description": "the 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", + "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", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -168095,7 +168148,7 @@ "name": "reconnectHost", "params": [ { - "description": "the host ID", + "description": "The host ID", "length": 255, "name": "id", "related": "reconnectHost", @@ -168106,258 +168159,157 @@ "related": "", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "True if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" + "description": "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, {}, - {}, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "The host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the CPU speed of the host", + "description": "The CPU speed of the host", "name": "cpuspeed", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the name of the host", - "name": "name", + "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", + "description": "The OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "The management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "Events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "The resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "The name of the host", + "name": "name", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "The host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "The host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "The host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", - "type": "string" - }, - { - "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": "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": "GPU cards present in the host", "name": "gpugroup", "response": [ { - "description": "the list of enabled vGPUs", + "description": "The list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vGPU per GPU card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Remaining capacity in terms of no. of more Instances that can be deployed 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" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -168366,13 +168318,13 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], @@ -168387,164 +168339,265 @@ "type": "list" }, { - "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": "Used GPUs on the Host", - "name": "gpuused", + "description": "The ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "True if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "The total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "Comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The Zone ID of the host", + "name": "zoneid", "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 state of the host", + "name": "state", + "type": "status" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "The amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "The cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "The last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "The host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "The incoming Network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "The amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "The date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "The average CPU load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the CPU number of the host", + "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 out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "The host version", + "name": "version", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "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 date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "The admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "The amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "The last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "True if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + {}, + { + "description": "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "CPU Arch of the host", + "name": "arch", + "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 cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "The date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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 ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "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 IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The Zone name of the host", + "name": "zonename", "type": "string" } ] @@ -168555,7 +168608,7 @@ "name": "startKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "The ID of the Kubernetes cluster", "length": 255, "name": "id", "related": "startKubernetesCluster", @@ -168566,97 +168619,104 @@ "related": "", "response": [ { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "The type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "The state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", - "name": "csienabled", - "type": "boolean" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "The name of the Kubernetes cluster", + "name": "name", "type": "string" }, + {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "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 name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, + {}, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "Keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "The size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "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 etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", + "description": "The ID of the service offering of the Kubernetes cluster", "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "True if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", + "description": "The name of the Kubernetes version for the Kubernetes cluster", "name": "kubernetesversionname", "type": "string" }, @@ -168666,155 +168726,148 @@ "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "Path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" - }, - { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "The name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "The name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the template of the Kubernetes cluster", - "name": "templatename", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", + "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 list of virtualmachines associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "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" }, { - "description": "keypair details", - "name": "keypair", + "description": "The project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "The ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "The ID of the Template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "The 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 zone of the Kubernetes cluster", - "name": "zonename", + "description": "The name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "The description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "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 ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "The ID of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, - {}, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "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": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "The project id of the Kubernetes cluster", + "name": "projectid", "type": "string" } ] @@ -168825,65 +168878,65 @@ "name": "getUploadParamsForKubernetesSupportedVersion", "params": [ { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" - }, - { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "format", + "name": "semanticversion", "required": true, "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "An optional domainId. If the Account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "An optional accountName. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", + "required": true, + "type": "integer" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, "name": "checksum", "required": false, "type": "string" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "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": "semanticversion", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "The name of the Volume/Template/ISO", "length": 255, - "name": "minmemory", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "Upload Volume/Template/ISO for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "The ID of the zone the Volume/Template/ISO is to be hosted on", "length": 255, "name": "zoneid", "related": "listZones", @@ -168891,16 +168944,16 @@ "type": "uuid" }, { - "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 minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "name": "mincpunumber", + "required": true, + "type": "integer" }, { - "description": "the name of the volume/template/iso", + "description": "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" } @@ -168908,39 +168961,34 @@ "related": "", "response": [ { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "The ID of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the URL of the binaries ISO for Kubernetes supported version", + "name": "isourl", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "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", + "description": "The date when this Kubernetes supported version was created", "name": "created", "type": "date" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "Whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, { "description": "Name of the Kubernetes supported version", @@ -168948,57 +168996,67 @@ "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": "Whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, {}, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "The enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "The ID of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "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": "The minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "The name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, - {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "The minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" - } + }, + {} ] }, { @@ -169007,7 +169065,7 @@ "name": "deleteProject", "params": [ { - "description": "true if all project resources have to be cleaned up, false otherwise", + "description": "True if all project resources have to be cleaned up, false otherwise", "length": 255, "name": "cleanup", "required": false, @@ -169015,7 +169073,7 @@ "type": "boolean" }, { - "description": "id of the project to be deleted", + "description": "ID of the project to be deleted", "length": 255, "name": "id", "related": "", @@ -169025,24 +169083,24 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "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", + "description": "The current status of the latest 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" }, {} @@ -169079,17 +169137,17 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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 name of the shared filesystem provider", "name": "name", @@ -169099,12 +169157,12 @@ "since": "4.20.0" }, { - "description": "List iso visibility and all accounts that have permissions to view this iso.", + "description": "List ISO visibility and all accounts that have permissions to view this ISO.", "isasync": false, "name": "listIsoPermissions", "params": [ { - "description": "the template ID", + "description": "The Template ID", "length": 255, "name": "id", "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", @@ -169116,41 +169174,41 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The list of projects the Template is available for", + "name": "projectids", + "type": "list" + }, + { + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", + "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 list of accounts the template is available for", + "description": "The list of Accounts the Template is available for", "name": "account", "type": "list" }, - {}, { - "description": "the template ID", + "description": "The Template ID", "name": "id", "type": "string" - } + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -169159,21 +169217,14 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "Private IP of the site", "length": 255, - "name": "isexclusivegslbprovider", + "name": "gslbproviderprivateip", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -169181,146 +169232,153 @@ "type": "uuid" }, { - "description": "public IP of the site", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "gslbproviderpublicip", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, { "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "username", + "name": "password", "required": true, "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": "Credentials to reach netscaler load balancer device", + "description": "Public IP of the site", "length": 255, - "name": "password", + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, + { + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "private IP of the site", + "description": "True if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "gslbproviderprivateip", + "name": "gslbprovider", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "Device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "Device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "Private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, - {}, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "Device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "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": "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": "device state", - "name": "lbdevicestate", + "description": "The public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "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", + "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 ID of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "True if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "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": "The physical Network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" } ] }, { - "description": "List backup schedule of a VM", + "description": "List backup schedule of an Instance", "isasync": false, "name": "listBackupSchedule", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -169328,27 +169386,18 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "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": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the VM", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -169358,11 +169407,11 @@ "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": "the ID of the backup schedule", @@ -169374,97 +169423,98 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "ID of the Instance", "length": 255, - "name": "isrecursive", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "account", + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ - { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "maximum number of backups retained", - "name": "maxbackups", - "type": "integer" - }, {}, { - "description": "quiesce the instance before checkpointing the disks for backup", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "time the backup is scheduled to be taken.", - "name": "schedule", + "description": "ID of the backup schedule.", + "name": "id", "type": "string" }, { - "description": "ID of the backup schedule.", - "name": "id", + "description": "ID of the Instance", + "name": "virtualmachineid", "type": "string" }, + { + "description": "maximum number of backups retained", + "name": "maxbackups", + "type": "integer" + }, {}, { - "description": "the time zone of the backup schedule", - "name": "timezone", + "description": "The time the backup is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of the VM", + "description": "Name of the Instance", "name": "virtualmachinename", "type": "string" }, { - "description": "the interval type of the backup schedule", + "description": "quiesce the instance before checkpointing the disks for backup", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "The interval type of the backup schedule", "name": "intervaltype", "type": "intervaltype" + }, + { + "description": "The time zone of the backup schedule", + "name": "timezone", + "type": "string" } ], "since": "4.14.0" }, { - "description": "Restore and attach a backed up volume to VM", + "description": "Restore and attach a backed up volume to Instance", "isasync": true, "name": "restoreVolumeFromBackupAndAttachToVM", "params": [ - { - "description": "ID of the VM backup", - "length": 255, - "name": "backupid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "ID of the volume backed up", "length": 255, @@ -169473,55 +169523,55 @@ "type": "string" }, { - "description": "id of the VM where to attach the restored volume", + "description": "ID of the Instance where to attach the restored volume", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the Instance backup", + "length": 255, + "name": "backupid", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "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.14.0" }, { - "description": "Removes network permissions.", + "description": "Removes Network permissions.", "isasync": false, "name": "removeNetworkPermissions", "params": [ { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "a comma delimited list of account IDs 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": "accountids", "related": "listAccounts", @@ -169529,129 +169579,137 @@ "type": "list" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "A comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "projectids", + "related": "", "required": false, "type": "list" }, { - "description": "the network ID", + "description": "The Network ID", "length": 255, "name": "networkid", "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" + }, + { + "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": "any text associated with the success or failure", + "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", + "description": "The current status of the latest async job acting 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", + "description": "True 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" }, { - "description": "config Tungsten-Fabric service", + "description": "Config Tungsten-Fabric service", "isasync": false, "name": "configTungstenFabricService", "params": [ { - "description": "the ID of physical network", + "description": "The ID of zone", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the ID of zone", + "description": "The ID of physical network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "physicalnetworkid", + "related": "", "required": true, "type": "uuid" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } ] }, { - "description": "list baremetal pxe server", + "description": "List baremetal pxe server", "isasync": false, "name": "listBaremetalPxeServers", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Pxe server device ID", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Pxe server device ID", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the Physical Network ID", + "description": "The Physical Network ID", "length": 255, "name": "physicalnetworkid", "related": "", @@ -169662,36 +169720,36 @@ "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device id of ", + "description": "Device ID of ", "name": "id", "type": "string" }, {}, + { + "description": "The physical Network to which this external DHCP device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", + "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": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "url", + "description": "URL", "name": "url", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -169711,142 +169769,142 @@ "related": "", "response": [ { - "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 domain name of the user", - "name": "domain", + "description": "The API key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "The secret key of the user", + "name": "secretkey", "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 email address", - "name": "email", - "type": "string" + "description": "The date and time the user Account was created", + "name": "created", + "type": "date" }, { - "description": "the user ID", - "name": "id", + "description": "The Account name of the user", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the account type of the user", + "description": "The Account type of the user", "name": "accounttype", "type": "integer" }, + {}, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "The user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "The name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "True if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "The user ID", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "True if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "The user name", + "name": "username", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "The user state", + "name": "state", "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", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "The domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "The user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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 ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "True if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "The user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "The type of the role", + "name": "roletype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "description": "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", "type": "apikeyaccess" - }, - {} + } ] }, { @@ -169855,305 +169913,305 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The name of the load balancer rule", "length": 255, - "name": "account", + "name": "name", "required": false, "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 name of the load balancer rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the availability zone ID", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "List by Network ID the rule belongs to", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "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. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "", "required": false, "type": "uuid" }, { - "description": "list by network ID the rule belongs to", + "description": "The ID of the Instance of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "The availability zone ID", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "zoneid", + "related": "listZones", "required": false, "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": "", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the list of resource tags associated with load balancer", + "description": "The protocol of the Load Balancer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The ID of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "The private port", + "name": "privateport", + "type": "string" + }, + { + "description": "Is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The domain ID of the Load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The project name of the Load balancer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "The Load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", + "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" }, { - "description": "tag value", - "name": "value", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "The public port", + "name": "publicport", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", + "description": "The name of the zone the Load balancer rule belongs to", "name": "zonename", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "The project ID of the Load balancer", + "name": "projectid", "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 port", - "name": "publicport", + "description": "The description of the Load balancer", + "name": "description", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The public IP address ID", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the name of the load balancer", + "description": "The name of the Load balancer", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the public ip address", + "description": "The public IP address", "name": "publicip", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The Account of the Load balancer rule", + "name": "account", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "The ID of the guest Network the LB rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "The Load balancer rule ID", + "name": "id", "type": "string" } ] @@ -170164,10 +170222,10 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The netmask for the management network.", + "description": "The ending IP address.", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { @@ -170179,26 +170237,19 @@ "type": "uuid" }, { - "description": "The gateway for the management network.", + "description": "The netmask for the management network.", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" }, { - "description": "The ending IP address.", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", "length": 255, - "name": "endip", + "name": "vlan", "required": false, "type": "string" }, - { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, { "description": "The starting IP address.", "length": 255, @@ -170207,205 +170258,212 @@ "type": "string" }, { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "description": "Specify if range is dedicated for CPVM and SSVM.", "length": 255, - "name": "vlan", + "name": "forsystemvms", "required": false, + "type": "boolean" + }, + { + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "the Zone ID of the Pod", + "description": "The starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "The Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Indicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "The Zone ID of the Pod", "name": "zoneid", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "The name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "The allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the IP ranges for the Pod", + "description": "The IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the gateway for the range", - "name": "gateway", + "description": "Indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "The ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "The starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "Indicates VLAN ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "The gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "The CIDR for the range", + "name": "cidr", "type": "string" } ], "type": "list" }, { - "description": "the capacity of the Pod", + "description": "The ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "The netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "The gateway of the Pod", + "name": "gateway", + "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 capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "The capacity name", + "name": "name", + "type": "string" + }, + { + "description": "The total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "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", + "description": "The Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the percentage of capacity currently in use", + "description": "The percentage of capacity currently in use", "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone name", + "description": "The Zone name", "name": "zonename", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "The capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", + "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 ID of the Pod", - "name": "id", - "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": "true if the entity/resource has annotations", + "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": "comma-separated list of storage access groups for the pod", - "name": "storageaccessgroups", - "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 netmask of the Pod", - "name": "netmask", - "type": "string" } ], "since": "4.11.0.0" @@ -170425,11 +170483,18 @@ { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "clusterid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -170440,124 +170505,109 @@ { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clusterid", + "related": "", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "Device state", + "name": "vsmdevicestate", "type": "string" }, + {}, { - "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": "device name", - "name": "vsmdevicename", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "description": "The management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", "name": "ipaddress", "type": "string" }, - {}, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Device ID of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" }, { - "description": "management vlan id of the VSM", + "description": "Management VLAN ID of the VSM", "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain ID", + "name": "vsmdomainid", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" + "description": "The current status of the latest 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 name", + "name": "vsmdevicename", "type": "string" }, { - "description": "storage vlan id of the VSM", + "description": "Storage VLAN ID of the VSM", "name": "vsmstoragevlanid", "type": "int" }, { - "description": "control vlan id of the VSM", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Control VLAN ID of the VSM", "name": "vsmctrlvlanid", "type": "int" } ] }, { - "description": "Adds vpn users", + "description": "Adds VPN Users", "isasync": true, "name": "addVpnUser", "params": [ { - "description": "password for the username", - "length": 255, - "name": "password", - "required": true, - "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": "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" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "An optional domainId for the VPN User. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "listDomains", @@ -170565,117 +170615,125 @@ "type": "uuid" }, { - "description": "username for the vpn user", + "description": "Password for the username", "length": 255, - "name": "username", + "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 id of the account of the remote access vpn", - "name": "domainid", + "description": "The VPN user ID", + "name": "id", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "The username of the VPN user", + "name": "username", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "The state of the VPN User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Path of the domain to which the remote access VPN belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 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 project name of the VPN", + "name": "project", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "The Account of the remote access VPN", + "name": "account", "type": "string" }, + {}, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", - "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 domain name of the Account of the remote access VPN", + "name": "domain", "type": "string" } ] }, { - "description": "Delete VM backup", + "description": "Delete Instance backup", "isasync": true, "name": "deleteBackup", "params": [ { - "description": "id of the VM backup", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering", + "description": "Force the deletion of backup which removes the entire backup chain but keep Instance in Backup Offering", "length": 255, "name": "forced", "required": false, "since": "4.18.0.0", "type": "boolean" + }, + { + "description": "ID of the Instance backup", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ], @@ -170704,28 +170762,28 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if operation is executed successfully", + "description": "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.15.0" }, @@ -170741,13 +170799,6 @@ "required": true, "type": "date" }, - { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, { "description": "The ID of the public IP address in active quarantine.", "length": 255, @@ -170755,25 +170806,27 @@ "related": "updateQuarantinedIp", "required": false, "type": "uuid" + }, + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", - "type": "string" - }, - { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { "description": "ID of the quarantine process.", @@ -170781,13 +170834,13 @@ "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { @@ -170796,26 +170849,31 @@ "type": "date" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.19" }, @@ -170825,529 +170883,529 @@ "name": "updateVnfTemplate", "params": [ { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", "length": 255, - "name": "arch", + "name": "forceupdateostype", "required": false, - "since": "4.20", - "type": "string" + "since": "4.21", + "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "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": "the name of the image file", + "description": "True if the Template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "name", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "The ID of the image file", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "requireshvm", + "name": "cleanupvnfnics", "required": false, "type": "boolean" }, { - "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": "string" + "type": "integer" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "isrouting", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "description": "True if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "cleanupvnfnics", + "name": "bootable", "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" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "True if the image supports the password reset feature; default is false", "length": 255, - "name": "ostypeid", - "related": "", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "The format for the image", "length": 255, - "name": "sortkey", + "name": "format", "required": false, - "type": "integer" + "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": "the tag for this template.", "length": 255, - "name": "cleanupdetails", + "name": "templatetag", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "the ID of the image file", + "description": "True if the Template supports the SSHkey upload feature; default is false", "length": 255, - "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", "length": 255, - "name": "vnfdetails", + "name": "isdynamicallyscalable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "forceupdateostype", + "name": "cleanupvnfdetails", "required": false, - "since": "4.21", "type": "boolean" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "isdynamicallyscalable", + "name": "vnfnics", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "The ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "cleanupvnfdetails", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "bootable", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", + "description": "The display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "map" + "type": "string" }, { - "description": "the format for the image", + "description": "The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "format", + "name": "templatetype", "required": false, "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", + "description": "The name of the image file", + "length": 251, + "name": "name", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "templatetype", + "name": "vnfdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "indicates that the template can be used for deployment of CKS clusters", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "forcks", + "name": "details", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "map" } ], "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the type of the template", - "name": "templatetype", + "description": "The date this Template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "True if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "The project ID of the Template", + "name": "projectid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The name of userdata linked to this Template", + "name": "userdataname", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "The 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": "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 userdata linked to this Template", + "name": "userdataid", + "type": "string" }, { - "description": "the template ID of the parent template if present", + "description": "The Template ID of the parent Template if present", "name": "sourcetemplateid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", + "description": "True if the Template is managed across all Zones, false otherwise", "name": "crossZones", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "If Datadisk Template, then id of the root disk Template this Template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The Template display text", + "name": "displaytext", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "The type of the Template", + "name": "templatetype", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "True if the Template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, - {}, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "The ID of the zone for this Template", + "name": "zoneid", + "type": "string" + }, + { + "description": "The project name of the Template", + "name": "project", + "type": "string" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "The Template ID", + "name": "id", + "type": "string" + }, + { + "description": "Additional key/value details tied with Template", + "name": "details", + "type": "map" + }, + { + "description": "True if this Template is a public Template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the date this template was created", + "description": "The date this Template was created", "name": "created", "type": "date" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Checksum of the Template", + "name": "checksum", + "type": "string" + }, + { + "description": "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "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 name of the OS type for this Template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + {}, + {}, + { + "description": "The Account id to which the Template belongs", + "name": "accountid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "The list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The project ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", + "description": "ID of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag value", + "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": "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "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", + "description": "True if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "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 template ID", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "The format of the Template.", + "name": "format", + "type": "imageformat" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", + "description": "VMware only: additional key/value details tied with deploy-as-is Template", "name": "deployasisdetails", "type": "map" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", + "description": "True if Template is sshkey enabled, false otherwise", "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The name of the zone for this Template", + "name": "zonename", "type": "string" }, { - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The tag of this Template", + "name": "templatetag", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "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", + "description": "True if Template requires HVM enabled, false otherwise", + "name": "requireshvm", "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 entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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.", + "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", + "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", - "name": "hostname", + "description": "The Account name to which the Template belongs", + "name": "account", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "The ID of the domain to which the Template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The name of extension linked to this template", + "name": "extensionname", "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 Template name", + "name": "name", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, - {}, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { - "description": "the template display text", - "name": "displaytext", + "description": "The status of the Template", + "name": "status", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the status of the template", - "name": "status", + "description": "The name of the secondary storage host for the Template", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 size of the Template", + "name": "size", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The URL which the Template/ISO is registered from", + "name": "url", "type": "string" }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, { "description": "CPU Arch of the template", "name": "arch", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", + "description": "The ID of the secondary storage host for the Template", "name": "hostid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.0" @@ -171358,146 +171416,181 @@ "name": "updateVPCOffering", "params": [ { - "description": "the display text of the VPC offering", + "description": "The name of the VPC offering", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "The ID of the VPC offering", "length": 255, - "name": "state", - "required": false, - "type": "string" + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { - "description": "the name of the VPC offering", + "description": "Sort key of the VPC offering, integer", "length": 255, - "name": "name", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "sort key of the VPC offering, integer", + "description": "The display text of the VPC offering", "length": 255, - "name": "sortkey", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "The ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 4096, - "name": "domainid", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "description": "The ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "Update state for the VPC offering; supported states - Enabled/Disabled", "length": 255, - "name": "zoneid", + "name": "state", "required": false, - "since": "4.13", "type": "string" } ], "related": "", "response": [ { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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", + "description": "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "Indicates if the VPC offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "true if network offering supports choosing AS numbers", + "description": "The routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "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 choosing AS numbers", "name": "specifyasnumber", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "True if VPC offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 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": "True if VPC offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + {}, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the internet protocol of the vpc offering", + "description": "The internet protocol of the VPC offering", "name": "internetprotocol", "type": "string" }, { - "description": "the list of supported services", + "description": "The ID of the VPC offering", + "name": "id", + "type": "string" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "The list of supported services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "The service provider name", + "name": "provider", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", + "description": "The provider name", "name": "name", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "The physical Network this belongs to", + "name": "physicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" }, { - "description": "the destination physical network", + "description": "The destination physical Network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", + "description": "UUID of the Network provider", "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", + "description": "State of the Network provider", "name": "state", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "Services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "true if individual services can be enabled/disabled", + "description": "True if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" } @@ -171505,152 +171598,91 @@ "type": "list" }, { - "description": "the service name", + "description": "The service name", "name": "name", "type": "string" + }, + { + "description": "The list of capabilities", + "name": "capability", + "response": [ + { + "description": "The capability name", + "name": "name", + "type": "string" + }, + { + "description": "Can this service capability value can be choosable while creatine Network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "The capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "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 id of the vpc offering", - "name": "id", + "description": "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, - {}, { - "description": "the name of the vpc offering", + "description": "The name of the VPC offering", "name": "name", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "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 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": "Lists authorized users who can used SAML SSO", + "description": "Lists user two factor authenticator providers", "isasync": false, - "name": "listSamlAuthorization", + "name": "listUserTwoFactorAuthenticatorProviders", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "List user two factor authenticator provider by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the user ID", - "name": "userid", + "description": "The user two factor authenticator provider name", + "name": "name", "type": "string" }, {}, { - "description": "the SAML authorization status", - "name": "status", - "type": "boolean" - }, - { - "description": "the authorized Identity Provider ID", - "name": "idpid", + "description": "The description of the user two factor authenticator provider", + "name": "description", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.18.0" }, { "description": "Lists extensions", @@ -171658,100 +171690,91 @@ "name": "listExtensions", "params": [ { - "description": "Name of the extension", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "comma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned.", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "List by keyword", + "description": "uuid of the extension", "length": 255, - "name": "keyword", + "name": "id", + "related": "listExtensions", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "comma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned.", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "uuid of the extension", + "description": "Name of the extension", "length": 255, - "name": "id", - "related": "listExtensions", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Description of the extension", - "name": "description", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "Name of the extension", - "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 extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ - { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" - }, - { - "description": "the details of the resource map", - "name": "details", - "type": "map" - }, { "description": "Type of the resource", "name": "type", "type": "string" }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, { "description": "ID of the resource associated with the extension", "name": "id", "type": "string" }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, { "description": "Name of the resource associated with this mapping", "name": "name", @@ -171761,16 +171784,25 @@ "type": "list" }, { - "description": "Type of the extension", - "name": "type", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, { - "description": "ID of the extension", - "name": "id", + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Name of the extension", + "name": "name", "type": "string" }, - {}, {}, { "description": "The details of the extension", @@ -171778,105 +171810,62 @@ "type": "map" }, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" + "description": "Description of the extension", + "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 extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { "description": "True if the extension is added by admin", "name": "isuserdefined", "type": "boolean" }, - { - "description": "The state of the extension", - "name": "state", - "type": "string" - } - ], - "since": "4.21.0" - }, - { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", - "params": [ - { - "description": "List user two factor authenticator provider by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the user two factor authenticator provider name", - "name": "name", - "type": "string" - }, - { - "description": "the description of the user two factor authenticator provider", - "name": "description", - "type": "string" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Resource detail names as comma separated string that should be reserved and not visible to end users", + "name": "reservedresourcedetails", "type": "string" } ], - "since": "4.18.0" + "since": "4.21.0" }, { - "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", + "description": "Scales the Instance to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", "isasync": true, "name": "scaleVirtualMachine", "params": [ { - "description": "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": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "The ID of the virtual machine", + "description": "The ID of the Instance", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "The ID of the service offering for the Instance", "length": 255, "name": "serviceofferingid", "related": "updateServiceOffering,listServiceOfferings", @@ -171884,15 +171873,7 @@ "type": "uuid" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, "name": "details", "required": false, @@ -171905,30 +171886,46 @@ "required": false, "since": "4.17", "type": "long" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "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": "any text associated with the 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", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on 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" } ] }, @@ -171938,7 +171935,7 @@ "name": "updateEgressFirewallRule", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "An optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -171946,166 +171943,166 @@ "type": "boolean" }, { - "description": "the ID of the egress firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, "name": "customid", "required": false, "since": "4.4", "type": "string" + }, + { + "description": "The ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, + { + "description": "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "The traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "The public IP address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "Error code for this ICMP message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "Type of the ICMP message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + { + "description": "The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "The ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "The ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "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 protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, { - "description": "the list of resource tags associated with the rule", + "description": "The list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "Tag key name", + "name": "key", "type": "string" }, { - "description": "the 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 ID the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "The domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 key name", - "name": "key", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 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 protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting port of firewall rule's port range", + "description": "The starting port of firewall rule's port range", "name": "startport", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "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", + "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", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -172117,46 +172114,59 @@ "name": "listOsCategories", "params": [ { - "description": "List OS categories for which a VNF template is available", + "description": "List OS category by name", "length": 255, - "name": "isvnf", + "name": "name", + "required": false, + "since": "3.0.1", + "type": "string" + }, + { + "description": "List OS categories types available for given CPU architecture", + "length": 255, + "name": "arch", "required": false, "since": "4.21.0", - "type": "boolean" + "type": "string" }, { - "description": "List OS category by id", + "description": "List OS categories for which a VNF template is available", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "isvnf", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "flag to display the resource image for the OS category", + "description": "List OS categories for which an ISO is available", "length": 255, - "name": "showicon", + "name": "isiso", "required": false, "since": "4.21.0", "type": "boolean" }, { - "description": "List OS category by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "since": "3.0.1", - "type": "string" + "type": "integer" }, { - "description": "List available OS categories types for the zone", + "description": "List OS category by ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "listOsCategories", "required": false, - "since": "4.21.0", "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List available OS categories by featured or not", "length": 255, @@ -172166,9 +172176,9 @@ "type": "boolean" }, { - "description": "List OS categories for which an ISO is available", + "description": "flag to display the resource image for the OS category", "length": 255, - "name": "isiso", + "name": "showicon", "required": false, "since": "4.21.0", "type": "boolean" @@ -172181,66 +172191,53 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List OS categories types available for given CPU architecture", + "description": "List available OS categories types for the zone", "length": 255, - "name": "arch", + "name": "zoneid", + "related": "listZones", "required": false, "since": "4.21.0", - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "the name of the OS category", - "name": "name", + "description": "The ID of the OS category", + "name": "id", "type": "string" }, { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" + "description": "The name of the OS category", + "name": "name", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the OS category", - "name": "id", - "type": "string" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Whether the OS category is featured", "name": "isfeatured", "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" } ] }, @@ -172250,37 +172247,51 @@ "name": "listServiceOfferings", "params": [ { - "description": "Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "gpuenabled", + "name": "state", "required": false, - "since": "4.21.0", - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the RAM memory that listed offering must support", + "description": "Listed offerings support root disk encryption", "length": 255, - "name": "memory", + "name": "encryptroot", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.18", + "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Name of the service offering", "length": 255, - "name": "storagetype", + "name": "name", "required": false, - "since": "4.19", "type": "string" }, + { + "description": " Is this a System VM offering", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" + }, + { + "description": "The ID of the template that listed offerings must support", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "since": "4.20.0", + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -172289,29 +172300,28 @@ "type": "string" }, { - "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "ID of the service offering", "length": 255, - "name": "state", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.19", - "type": "string" + "type": "uuid" }, { - "description": "The ID of the vGPU profile that listed offerings must support", + "description": "ID of zone disk offering is associated with", "length": 255, - "name": "vgpuprofileid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.21.0", + "since": "4.13", "type": "uuid" }, { - "description": "listed offerings support root disk encryption", + "description": "", "length": 255, - "name": "encryptroot", + "name": "pagesize", "required": false, - "since": "4.18", - "type": "boolean" + "type": "integer" }, { "description": "", @@ -172321,44 +172331,32 @@ "type": "integer" }, { - "description": "the CPU speed that listed offerings must support", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "cpuspeed", + "name": "storagetype", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "is this a system vm offering", + "description": "Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.", "length": 255, - "name": "issystem", + "name": "gpuenabled", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the vGPU profile that listed offerings must support", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vgpuprofileid", + "related": "", "required": false, + "since": "4.21.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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the CPU number that listed offerings must support", + "description": "The CPU number that listed offerings must support", "length": 255, "name": "cpunumber", "required": false, @@ -172366,406 +172364,405 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by Account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the service offering", + "description": "The system Instance type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "systemvmtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "name of the service offering", + "description": "The RAM memory that listed offering must support", "length": 255, - "name": "name", + "name": "memory", "required": false, - "type": "string" + "since": "4.15", + "type": "integer" }, { - "description": "The ID of the template that listed offerings must support", + "description": "The ID of the Instance. Pass this in if you want to see the available service offering that an Instance can be changed to.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.20.0", "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The CPU speed that listed offerings must support", "length": 255, - "name": "projectid", - "related": "", + "name": "cpuspeed", "required": false, - "type": "uuid" + "since": "4.15", + "type": "integer" }, { - "description": "id of zone disk offering is associated with", + "description": "List only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List objects by project; if projectid=-1 lists All Instances", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "updateServiceOffering", "response": [ { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "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": "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 host tag for the service offering", + "name": "hosttags", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "Deployment strategy used to deploy Instance.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "The vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", - "type": "boolean" + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "Burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "Burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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 second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "Bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", - "type": "integer" + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", - "name": "cacheMode", + "description": "State of the service offering", + "name": "state", "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 Instance needs to be dynamically scalable of CPU or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "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": "True if Instance root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "The HA support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the count of GPUs to attach ", + "name": "gpucount", + "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": "Instance lease duration (in days) for service offering", - "name": "leaseduration", + "description": "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, + { + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "type": "boolean" + }, { "description": "the maximum number of display heads", "name": "maxheads", "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "Burst I/O requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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 iops, false otherwise", - "name": "iscustomizediops", + "description": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, + {}, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "The name of the service offering", + "name": "name", "type": "string" }, { - "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": "is this a default system vm offering", + "description": "Is this a default System VM offering", "name": "defaultuse", "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "Is this a the System VM type for System VM offering", + "name": "systemvmtype", "type": "string" }, { - "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "Data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "The ID of the service offering", + "name": "id", "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "Is this a System VM offering", + "name": "issystem", "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "The max IOPS of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "I/O requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "Burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "Bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "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": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "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": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "Additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, + {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "Length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "The clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "The min IOPS of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "The number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "The memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "Restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, - {}, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", "type": "integer" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "The storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "The date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "True if the Instance needs to be volatile, i.e., on every reboot of Instance 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 tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "Is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", - "type": "string" + "description": "I/O requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" } ] }, @@ -172775,52 +172772,22 @@ "name": "importVm", "params": [ { - "description": "(only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).", - "length": 255, - "name": "forceconverttopool", - "required": false, - "since": "4.22", - "type": "boolean" - }, - { - "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", + "description": "Host where local disk is located", "length": 255, - "name": "convertinstancehostid", + "name": "hostid", "related": "", "required": false, "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" - }, - { - "description": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "vcenter", + "name": "hostip", "required": false, "type": "string" }, { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, - { - "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", - "length": 255, - "name": "forcemstoimportvmfiles", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the template for the virtual machine", + "description": "The ID of the Template for the Instance", "length": 255, "name": "templateid", "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", @@ -172828,168 +172795,159 @@ "type": "uuid" }, { - "description": "import instance to the domain specified", + "description": "(only for importing VMs from VMware to KVM) optional - if true, uses VDDK on the KVM conversion host for converting the VM. This parameter is mutually exclusive with forcemstoimportvmfiles.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "usevddk", "required": false, - "type": "uuid" + "since": "4.22.1", + "type": "boolean" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", "length": 255, - "name": "migrateallowed", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "existingvcenterid", + "name": "convertinstancepoolid", "related": "", "required": false, "type": "uuid" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "The service offering for the Instance", "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the username for the host", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "username", + "name": "temppath", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the host name or IP address", "length": 255, - "name": "account", + "name": "host", "required": false, "type": "string" }, { - "description": "Shared storage pool where disk is located", + "description": "(only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).", "length": 255, - "name": "storageid", - "related": "", + "name": "forceconverttopool", "required": false, - "type": "uuid" + "since": "4.22", + "type": "boolean" }, { - "description": "the cluster ID", + "description": "hypervisor type of the host", "length": 255, - "name": "clusterid", - "related": "", + "name": "hypervisor", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "VM NIC to ip address mapping using keys NIC, ip4Address", "length": 255, - "name": "details", + "name": "nicipaddresslist", "required": false, "type": "map" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", "length": 255, - "name": "datadiskofferinglist", + "name": "clustername", "required": false, - "type": "map" + "type": "string" }, { - "description": "import instance for the project", + "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", "length": 255, - "name": "projectid", - "related": "", + "name": "forcemstoimportvmfiles", "required": false, + "type": "boolean" + }, + { + "description": "The cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator", + "description": "the username for the host", "length": 255, - "name": "extraparams", + "name": "username", "required": false, - "since": "4.22", "type": "string" }, { - "description": "the network ID", + "description": "The name of the Instance as it is known to the hypervisor", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", + "description": "(only for importing VMs from VMware to KVM) optional - the ID of the guest OS for the imported VM.", "length": 255, - "name": "convertinstancepoolid", + "name": "osid", "related": "", "required": false, + "since": "4.22.1", "type": "uuid" }, { - "description": "the display name of the instance", + "description": "VM NIC to network id mapping using keys NIC and network", "length": 255, - "name": "displayname", + "name": "nicnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "path of the disk image", + "description": "Source location for Import", "length": 255, - "name": "diskpath", - "required": false, + "name": "importsource", + "required": true, "type": "string" }, { - "description": "Host where local disk is located", + "description": "Import Instance to the domain specified", "length": 255, - "name": "hostid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "description": "the network ID", "length": 255, - "name": "importinstancehostid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "since": "4.19.2", "type": "uuid" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "The host name of the Instance", "length": 255, - "name": "name", - "required": true, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "Source location for Import", + "description": "The display name of the Instance", "length": 255, - "name": "importsource", - "required": true, + "name": "displayname", + "required": false, "type": "string" }, { @@ -173001,1211 +172959,1272 @@ "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "hostip", + "name": "storageid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host name or IP address", + "description": "path of the disk image", "length": 255, - "name": "host", + "name": "diskpath", "required": false, "type": "string" }, { - "description": "the host name of the instance", + "description": "Datadisk Template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "hostname", + "name": "datadiskofferinglist", "required": false, - "type": "string" + "type": "map" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "description": "An optional account for the Instance. Must be used with domainId.", "length": 255, - "name": "clustername", + "name": "account", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator", "length": 255, - "name": "password", + "name": "extraparams", "required": false, + "since": "4.22", "type": "string" }, { - "description": "Temp Path on external host for disk image copy", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "temppath", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "the password for the host", "length": 255, - "name": "datacentername", + "name": "password", "required": false, "type": "string" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", - "response": [ - { - "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": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Instance 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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", + "length": 255, + "name": "convertinstancehostid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "length": 255, + "name": "importinstancehostid", + "related": "", + "required": false, + "since": "4.19.2", + "type": "uuid" }, { - "description": "the project id of the vm", + "description": "Import Instance for the project", + "length": 255, "name": "projectid", - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + } + ], + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "The domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The name of the security group", + "name": "name", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "Security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "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": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "set" + }, + { + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The 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 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 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "Account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "The protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the nic", + "description": "The ID of the security group", "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The project name of the group", + "name": "project", "type": "string" - }, + } + ], + "type": "set" + }, + {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "The type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", + "description": "The project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "OS name of the Instance", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The internal memory (KiB) that's free in Instance 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 list of NICs associated with Instance", + "name": "nic", + "response": [ + { + "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" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "The IP address of the NIC", + "name": "ipaddress", "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": "Id of the vm to which the nic belongs", + "description": "Id of the Instance to which the NIC belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", "name": "ipaddresses", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Device ID for the Network when plugged into the Instance", + "name": "deviceid", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The IPv6 address of Network", + "name": "ip6address", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "The gateway of IPv6 Network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "The ID of the corresponding Network", + "name": "networkid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "The ID of the NIC", + "name": "id", "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 description of the affinity group", - "name": "description", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the 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": "True if NIC is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "The type of the NIC", + "name": "type", + "type": "string" + }, + { + "description": "The extra DHCP options on the NIC", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "The name of the domain in which the Instance exists", + "name": "domain", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The Account associated with the Instance", + "name": "account", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "The group ID of the Instance", + "name": "groupid", "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "The project name of the Instance", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "The name of the service offering of the Instance", "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The ID of the Instance", + "name": "id", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", + "description": "An alternate display text of the Template for the Instance", "name": "templatedisplaytext", "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "Guest Instance 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", - "type": "boolean" + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "The project ID of the Instance", + "name": "projectid", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "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": "Instance details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS type ID of the Instance", + "name": "guestosid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The name of the availability zone for the Instance", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", "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": "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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" - } - ], - "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", + "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "OS type id of the Instance", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the virtual machine", + "description": "The name of the Instance", "name": "name", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "The pool type of the Instance", + "name": "pooltype", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "The name of the Template for the Instance", + "name": "templatename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "Customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", + "description": "The password (if exists) of the Instance", "name": "password", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, + {}, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "An optional field whether to the display the Instance to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The ID of the host for the Instance", + "name": "hostid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The outgoing Network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" } ], @@ -174225,7 +174244,7 @@ "type": "uuid" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "The list load balancer rules that will be assigned to global load balancer rule", "length": 255, "name": "loadbalancerrulelist", "related": "", @@ -174235,27 +174254,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", + "description": "True if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {}, + {} ] }, { @@ -174287,23 +174306,23 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "the type of the affinity group", + "description": "The type of the affinity group", "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "description": "The current status of the latest async job acting 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" - } + {}, + {} ] }, { @@ -174311,6 +174330,13 @@ "isasync": false, "name": "listCapacity", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "Sort the results. Available values: Usage", "length": 255, @@ -174328,144 +174354,137 @@ "type": "string" }, { - "description": "", + "description": "Lists capacity by the Cluster ID", "length": 255, - "name": "page", + "name": "clusterid", + "related": "", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "uuid" }, { - "description": "", + "description": "Lists capacity by the Zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists capacity by the Pod ID", + "description": "Recalculate capacities and fetch the latest", "length": 255, - "name": "podid", - "related": "", + "name": "fetchlatest", "required": false, - "type": "uuid" + "since": "3.0.0", + "type": "boolean" }, { - "description": "lists capacity by the Zone ID", + "description": "Lists capacity by the Pod ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "podid", + "related": "", "required": false, "type": "uuid" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "description": "Lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", "length": 255, "name": "type", "required": false, "type": "integer" }, { - "description": "recalculate capacities and fetch the latest", - "length": 255, - "name": "fetchlatest", - "required": false, - "since": "3.0.0", - "type": "boolean" - }, - { - "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": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "The capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "The Pod ID", + "name": "podid", "type": "string" }, - {}, { - "description": "the Pod name", - "name": "podname", + "description": "The Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity name", + "description": "The capacity name", "name": "name", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The Pod name", + "name": "podname", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "The Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "The total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "The current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the percentage of capacity currently in use", + "description": "The percentage of capacity currently in use", "name": "percentused", "type": "string" }, + {}, { - "description": "the capacity type", + "description": "The capacity type", "name": "type", "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "The capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Zone name", + "name": "zonename", "type": "string" } ] @@ -174476,33 +174495,41 @@ "name": "updateServiceOffering", "params": [ { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", + "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.16", + "since": "4.13", "type": "string" }, { - "description": "state of the service offering", + "description": "Sort key of the service offering, integer", "length": 255, - "name": "state", + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "The ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, "type": "string" }, { - "description": "the ID of the service offering to be updated", + "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this offering, externaldetails field ignored; if false or not set, no action)", "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "cleanupexternaldetails", + "required": false, + "since": "4.22.0", + "type": "boolean" }, { - "description": "the name of the service offering to be updated", + "description": "Comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, - "name": "name", + "name": "storagetags", "required": false, + "since": "4.16", "type": "string" }, { @@ -174514,276 +174541,116 @@ "type": "boolean" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "The ID of the service offering to be updated", "length": 255, - "name": "externaldetails", - "required": false, - "since": "4.21.0", - "type": "map" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "type": "string" + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "sort key of the service offering, integer", + "description": "The host tag for this service offering.", "length": 255, - "name": "sortkey", + "name": "hosttags", "required": false, - "type": "integer" + "since": "4.16", + "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "state of the service offering", "length": 255, - "name": "zoneid", + "name": "state", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the display text of the service offering to be updated", + "description": "The name of the service offering to be updated", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "The display text of the service offering to be updated", "length": 255, - "name": "storagetags", + "name": "displaytext", "required": false, - "since": "4.16", "type": "string" }, { - "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this offering, externaldetails field ignored; if false or not set, no action)", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "cleanupexternaldetails", + "name": "externaldetails", "required": false, - "since": "4.22.0", - "type": "boolean" + "since": "4.21.0", + "type": "map" } ], "related": "", "response": [ { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "the name of the service offering", - "name": "name", - "type": "string" - }, - { - "description": "Instance lease duration (in days) for service offering", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "An alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "burst bytes write rate of the disk offering", + "description": "Burst bytes write rate of the disk offering", "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the min iops of the disk offering", + "description": "The min IOPS of the disk offering", "name": "miniops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, - { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "I/O requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, - { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "Length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "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": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "Name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "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", - "type": "boolean" - }, - { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "Is this a default System VM offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "the storage type for this service offering", + "description": "The storage type for this service offering", "name": "storagetype", "type": "string" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "is true if the offering is customized", - "name": "iscustomized", - "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 count of GPUs to attach ", - "name": "gpucount", + "description": "The number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", - "name": "cacheMode", + "description": "State of the service offering", + "name": "state", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { @@ -174792,753 +174659,440 @@ "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "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 maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the memory in MB", - "name": "memory", + "description": "Data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "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": "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", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "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 ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "state of the service offering", - "name": "state", - "type": "string" - }, - { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", - "type": "boolean" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - } - ] - }, - { - "description": "Stops a virtual machine.", - "isasync": true, - "name": "stopVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", - "response": [ - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the memory allocated for the virtual machine", + "description": "The memory in MB", "name": "memory", "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "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": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "The date this service offering was created", + "name": "created", + "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 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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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 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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - } - ], - "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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "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": "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "The ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "True if disk offering uses custom IOPS, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "True if Instance needs to be dynamically scalable of CPU or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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": "Burst I/O requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The max IOPS of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "Burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, + { + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "The display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "Is this a System VM offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "Length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "Is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + {}, + { + "description": "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "Deployment strategy used to deploy Instance.", + "name": "deploymentplanner", + "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": "Action to be taken once lease is over", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "The HA support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "The tags for the service offering", + "name": "storagetags", + "type": "string" + }, + { + "description": "The name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" + }, + { + "description": "True if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "True if Instance root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "The host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "I/O 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": "Bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "Restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + {}, + { + "description": "Burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "Length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "Is this a the System VM type for System VM offering", + "name": "systemvmtype", + "type": "string" + } + ] + }, + { + "description": "Stops an Instance.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "The ID of the Instance", + "length": 255, + "name": "id", + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" + }, + { + "description": "Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the Instance is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "createVMFromBackup,deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "True if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "The format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "The name of the backup offering of the Instance", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "The virtual Network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "The ID of the domain in which the Instance exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The list of resource tags associated", + "name": "tags", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "The ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "ID of the resource", + "name": "resourceid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "The Account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "The project ID the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "The project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", + "description": "Path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "The domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "Vm details in key/value pairs.", + "description": "The amount of the Instance's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "The name of the service offering of the Instance", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "The Account associated with the Instance", + "name": "account", + "type": "string" + }, + { + "description": "Device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicip", + "type": "string" + }, + { + "description": "The name of the ISO attached to the Instance", + "name": "isoname", + "type": "string" + }, + {}, + { + "description": "Instance details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The ID of the availability zone for the Instance", + "name": "zoneid", + "type": "string" + }, + { + "description": "User generated name. The name of the Instance is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "The group ID of the Instance", + "name": "groupid", + "type": "string" }, { "description": "the maximum Y resolution", @@ -175546,631 +175100,1101 @@ "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest Instance Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The ID of the service offering of the Instance", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS name of the Instance", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "The Instance's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "An alternate display text of the Template for the Instance", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The date when this Instance was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "The read (IO) of disk on the Instance", + "name": "diskioread", + "type": "long" + }, + { + "description": "The memory used by the Instance in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "OS type id of the Instance", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the template for the virtual machine", + "description": "The name of the Template for the Instance", "name": "templatename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Public IP address id associated with Instance via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "The ID of the host for the Instance", + "name": "hostid", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "True if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the list of nics associated with vm", + "description": "The list of NICs associated with Instance", "name": "nic", "response": [ { - "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Public IP address associated with this NIC via Static NAT rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The 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", + "description": "The isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The gateway of the NIC", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "The isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "The traffic type of the NIC", + "name": "traffictype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "The type of the NIC", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the Instance to which the NIC belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The IP address of the NIC", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the corresponding network", + "description": "The ID of the corresponding Network", "name": "networkid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", + "description": "The CIDR of IPv6 Network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Name of the VPC to which the NIC belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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 ID of the NIC", + "name": "id", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged Instance", "name": "ipaddresses", "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "The name of the corresponding Network", + "name": "networkname", "type": "string" }, { - "description": "the netmask of the nic", + "description": "The Secondary IPv4 addr of NIC", + "name": "secondaryip", + "type": "list" + }, + { + "description": "The netmask of the NIC", "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", + "description": "Device ID for the Network when plugged into the Instance", "name": "deviceid", "type": "string" }, { - "description": "the IPv6 address of network", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "The IPv6 address of Network", "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Public IP address ID associated with this NIC via Static NAT rule", + "name": "publicipid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "The isolation URI of the NIC", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "True if NIC is default, false otherwise", + "name": "macaddress", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "The broadcast URI of the NIC", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "SSH key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Name of AutoScale Instance group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "The ID of userdata used for the Instance", + "name": "userdataid", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "The name of the Instance", + "name": "name", + "type": "string" + }, + { + "description": "The ID of the Instance", + "name": "id", + "type": "string" + }, + { + "description": "The group name of the Instance", + "name": "group", + "type": "string" + }, + { + "description": "The name of the domain in which the Instance exists", + "name": "domain", + "type": "string" + }, + { + "description": "List of Affinity groups associated with the Instance", + "name": "affinitygroup", + "response": [ + { + "description": "The project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "The account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "The domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "The ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Instance IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "The name of the affinity group", + "name": "name", "type": "string" }, { - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "The type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "The description of the affinity group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The ID of the ISO attached to the Instance", + "name": "isoid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The vGPU type used by the Instance", + "name": "vgpu", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "The state of the Instance", + "name": "state", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "The userdata override policy with the userdata provided while deploying Instance", + "name": "userdatapolicy", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of security groups associated with the Instance", + "name": "securitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "The list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "The domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The Account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The Account owning the security group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "The project id of the group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "The domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The project name of the group", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "The list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "The 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 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": "Path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "Tag key name", + "name": "key", + "type": "string" + }, + { + "description": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "The project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "The ID of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "The type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "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": "Account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "The list of Instance IDs associated with this Security Group", + "name": "virtualmachineids", + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "Path of the Domain associated with the tag", + "name": "domainpath", + "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": "ID of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "Resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "The project ID the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "Tag value", + "name": "value", + "type": "string" + }, + { + "description": "The 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": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "The code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "The ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "The starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "The number of Instances associated with this Security Group", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "The name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "An alternate display text of the ISO attached to the Instance", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "The name of the availability zone for the Instance", + "name": "zonename", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The pool type of the Instance", + "name": "pooltype", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The User's name who deployed the Instance", + "name": "username", "type": "string" }, { - "description": "the project name of the vm", + "description": "The project name of the Instance", "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Guest Instance Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", + "name": "alloweddetails", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The project ID of the Instance", + "name": "projectid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The hypervisor on which the Template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance 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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "An optional field whether to the display the Instance 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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Instance name of the user Instance; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "True if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "The control state of the host for the Instance", + "name": "hostcontrolstate", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The number of vCPUs this Instance is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The User's ID who deployed the Instance", + "name": "userid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The memory allocated for the Instance", + "name": "memory", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The date when this Instance was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "The total number of Network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "OS type ID of the Instance", + "name": "guestosid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The name of userdata used for the Instance", + "name": "userdataname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the speed of each vCPU", + "description": "The speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "ID of AutoScale Instance group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The name of the host for the Instance", + "name": "hostname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The password (if exists) of the Instance", + "name": "password", + "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "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", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The Instance's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "The incoming Network traffic on the Instance in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "List of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The write (IO) of disk on the Instance", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "The target memory in Instance (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "The total number of Network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The ID of the backup offering of the Instance", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "List of read-only Instance details as comma separated string.", + "name": "readonlydetails", "type": "string" } ] }, { - "description": "Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.", + "description": "Creates a Network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.", "isasync": true, "name": "createNetworkACLList", "params": [ { - "description": "ID of the VPC associated with this network ACL list", + "description": "An optional field, whether to the display the list to the end User or not", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "Name of the network ACL list", + "description": "ID of the VPC associated with this Network ACL list", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "Description of the network ACL list", + "description": "Description of the Network ACL list", "length": 255, "name": "description", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "Name of the Network ACL list", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the current status of the latest async job acting on this object", + "description": "The current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "Description of the ACL", + "name": "description", "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": "the ID of the ACL", - "name": "id", + "description": "The Name of the ACL", + "name": "name", "type": "string" }, + {}, { - "description": "Description of the ACL", - "name": "description", + "description": "The UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "The ID of the ACL", + "name": "id", "type": "string" }, { - "description": "is ACL for display to the regular user", + "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" + } ] } ], - "count": 912 + "count": 903 } diff --git a/generate/requiredParams.go b/generate/requiredParams.go index 2df5061..5880f7a 100644 --- a/generate/requiredParams.go +++ b/generate/requiredParams.go @@ -70,6 +70,9 @@ var requiredParams = map[string][]string{ "registerTemplate": { "displaytext", }, + "queryAsyncJobResult": { + "jobid", + }, "updateGuestOs": { "osdisplayname", },