Net::CloudStack::API - Basic request and response handling for calls to a CloudStack service.
This document describes v0.02 of Net::CloudStack::API - released July 13, 2012 as part of Net-CloudStack-API.
use Net::CloudStack::API; my $cs = Net::CloudStack::API->new; $cs->api( 'see Net::CloudStack docs for setup details' ); print $cs->listVolumes; use Net::CloudStack::API 'listVolumes'; Net::CloudStack::API::api( 'see Net::CloudStack docs for setup details' ); print listVolume(); use Net::CloudStack::API ':Volume'; Net::CloudStack::API::api( 'see Net::CloudStack docs for setup details' ); print listVolumes();
This module handles parameter checking for the various calls available from a cloudstack service.
Probably should include some explanatory text here about how this file is generated.
Something about how these are the methods available.
(A) indicates the method is asynchronous.
Include text and reference here for async calls from docs.
Creates an account
User Level: 3 (FIXME: this needs to be improved)
Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin
email
firstname
lastname
Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.
Unique username.
Creates the user under the specified account. If no account is specified, the username will be used as the account name.
Creates the user under the specified domain.
Network domain for the account's networks
Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
the account name of the user
the account type of the user
the api key of the user
the date and time the user account was created
the domain name of the user
the domain ID of the user
the user email address
the user firstname
the user ID
the user lastname
the secret key of the user
the user state
the timezone user was created in
the user name
Deletes a account, and all users associated with this account
Account id
any text associated with the success or failure
true if operation is executed successfully
Updates account information for the authenticated user
the current account name
the ID of the domain where the account exists
new name for the account
account type (admin, domain-admin, user)
name of the Domain the account belongs too
id of the Domain the account belongs too
the id of the account
the total number of public ip addresses available for this account to acquire
the total number of public ip addresses this account can acquire
the total number of public ip addresses allocated for this account
true if the account requires cleanup
the name of the account
the network domain
the total number of network traffic bytes received
the total number of network traffic bytes sent
the total number of snapshots available for this account
the total number of snapshots which can be stored by this account
the total number of snapshots stored by this account
the state of the account
the total number of templates available to be created by this account
the total number of templates which can be created by this account
the total number of templates which have been created by this account
the list of users associated with account
the total number of virtual machines available for this account to acquire
the total number of virtual machines that can be deployed by this account
the total number of virtual machines running for this account
the total number of virtual machines stopped for this account
the total number of virtual machines deployed by this account
the total volume available for this account
the total volume which can be used by this account
the total volume being used by this account
Disables an account
User Level: 7 (FIXME: this needs to be improved)
Disables specified account.
Disables specified account in this domain.
If true, only lock the account; else disable the account
Enables an account
Enables specified account.
Enables specified account in this domain.
Lists accounts and provides detailed account information for listed accounts
User Level: 15 (FIXME: this needs to be improved)
list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).
list all accounts in specified domain. If used with the name parameter, retrieves account information for the account with specified name in specified domain.
list account by account ID
list accounts by cleanuprequred attribute (values are true or false)
defaults to false, but if true, lists all accounts from the parent specified by the domain id till leaves.
List by keyword
list account by account name
no description
list accounts by state. Valid states are enabled, disabled, and locked.
Acquires and associates a public IP to an account.
the ID of the availability zone you want to acquire an public IP address from
the account to associate with this IP address
the ID of the domain to associate with this IP address
The network this ip address should be associated to.
the account the public IP address is associated with
date the public IP address was acquired
the ID of the Network associated with the IP address
the domain the public IP address is associated with
the domain ID the public IP address is associated with
the virtual network for the IP address
public IP address id
public IP address
true if the IP address is a source nat address, false otherwise
true if this ip is for static nat, false otherwise
shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the volume
shows the current pending asynchronous job status
the ID of the Network where ip belongs to
State of the ip address. Can be: Allocatin, Allocated and Releasing
virutal machine display name the ip address is assigned to (not null only for static nat Ip)
virutal machine id the ip address is assigned to (not null only for static nat Ip)
virutal machine name the ip address is assigned to (not null only for static nat Ip)
the ID of the VLAN associated with the IP address
the VLAN associated with the IP address
the ID of the zone the public IP address belongs to
the name of the zone the public IP address belongs to
Disassociates an ip address from the account.
the id of the public ip address to disassociate
Lists all public ip addresses
lists all public IP addresses by account. Must be used with the domainId parameter.
limits search results to allocated public IP addresses
lists all public IP addresses by domain ID. If used with the account parameter, lists all public IP addresses by account for specified domain.
list only ips used for load balancing
lists ip address by id
lists the specified IP address
lists all public IP addresses by VLAN ID
lists all public IP addresses by Zone ID
Lists all alerts.
the ID of the alert
list by alert type
description of the alert
the id of the alert
the date and time the alert was sent
the alert type
Retrieves the current status of asynchronous job.
the ID of the asychronous job
the account that executed the async command
the async command executed
the created date of the job
async job ID
the unique ID of the instance/entity object related to the job
the instance/entity object related to the job
the progress information of the PENDING job
the result reason
the result code for the job
the result type
the current job status-should be 0 for PENDING
the user that executed the async command
Lists all pending asynchronous jobs for the account.
the account associated with the async job. Must be used with the domainId parameter.
the domain ID associated with the async job. If used with the account parameter, returns async jobs for the account in the specified domain.
the start date of the async job
Uploads custom certificate
User Level: 1 (FIXME: this needs to be improved)
the custom cert to be uploaded
DNS domain suffix that the certificate is granted for
the custom cert id in the chain
the alias of the certificate
the private key for the certificate
message of the certificate upload operation
Retrieves a cloud identifier.
the user ID for the cloud identifier
the cloud identifier
the signed response for the cloud identifier
Updates a configuration.
the name of the configuration
the value of the configuration
the category of the configuration
the description of the configuration
Lists all configurations.
lists configurations by category
lists configuration by name
Adds configuration value
component's category
the component of the configuration
the instance of the configuration
Lists capabilities
version of the cloud stack
true if the firewall rule UI is enabled
true if security groups support is enabled, false otherwise
true if region supports elastic load balancer on basic zones
true if user and domain admins can set templates to be shared, false otherwise
Creates a disk offering.
alternate display text of the disk offering
name of the disk offering
whether disk offering is custom or not
size of the disk offering in GB
the ID of the containing domain, null for public offerings
tags for the disk offering
the date this disk offering was created
the size of the disk offering in GB
an alternate display text of the disk offering.
the domain name this disk offering belongs to. Ignore this information as it is not currently applicable.
the domain ID this disk offering belongs to. Ignore this information as it is not currently applicable.
unique ID of the disk offering
true if disk offering uses custom size, false otherwise
the name of the disk offering
the tags for the disk offering
Updates a disk offering.
ID of the disk offering
updates alternate display text of the disk offering with this value
updates name of the disk offering with this value
Lists all available disk offerings.
the ID of the domain of the disk offering.
Creates a domain
creates domain with this name
Network domain for networks in the domain
assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.
whether the domain has one or more sub-domains
the ID of the domain
the level of the domain
the name of the domain
the domain ID of the parent domain
the domain name of the parent domain
the path of the domain
Updates a domain with a new name
ID of domain to update
updates domain with this name
Network domain for the domain's networks
Deletes a specified domain
ID of domain to delete
true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise
Lists domains and provides detailed information for listed domains
List domain by domain ID.
List domains by domain level.
List domain by domain name.
Lists all children domains belonging to a specified domain
list children domain by parent domain ID.
to return the entire tree, use the value "true". To return the first level children, use the value "false".
list children domains by name
A command to list events.
the account for the event. Must be used with the domainId parameter.
the domain ID for the event. If used with the account parameter, returns all events for an account in the specified domain ID.
the duration of the event
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")
the time the event was entered
the ID of the event
the event level (INFO, WARN, ERROR)
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")
the event type (see event types)
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)
the date the event was created
a brief description of the event
the name of the account's domain
the id of the account's domain
whether the event is parented
the state of the event
the type of the event (see event types)
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)
List Event Types
Event Type
Adds an external firewall appliance
Password of the external firewall appliance.
URL of the external firewall appliance.
Username of the external firewall appliance.
Zone in which to add the external firewall appliance.
the ID of the external firewall
the management IP address of the external firewall
the number of times to retry requests to the external firewall
the private interface of the external firewall
the private security zone of the external firewall
the public interface of the external firewall
the public security zone of the external firewall
the timeout (in seconds) for requests to the external firewall
the usage interface of the external firewall
the username that's used to log in to the external firewall
the zone ID of the external firewall
Deletes an external firewall appliance.
Id of the external firewall appliance.
List external firewall appliances.
zone Id
Adds an external load balancer appliance.
Password of the external load balancer appliance.
URL of the external load balancer appliance.
Username of the external load balancer appliance.
Zone in which to add the external load balancer appliance.
the ID of the external load balancer
configures the external load balancer to be inline with an external firewall
the management IP address of the external load balancer
the number of times to retry requests to the external load balancer
the private interface of the external load balancer
the public interface of the external load balancer
the username that's used to log in to the external load balancer
the zone ID of the external load balancer
Deletes an external load balancer appliance.
Id of the external loadbalancer appliance.
List external load balancer appliances.
the allocation state of the host
the cpu average load on the host
capabilities of the host
the cluster ID of the host
the cluster name of the host
the cluster type of the cluster that host belongs to
the amount of the host's CPU currently allocated
the CPU number of the host
the CPU speed of the host
the amount of the host's CPU currently used
the amount of the host's CPU after applying the cpu.overprovisioning.factor
the date and time the host was created
true if the host is disconnected. False otherwise.
the host's currently allocated disk size
the total disk size of the host
events available for the host
true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
comma-separated list of tags for the host
the host hypervisor
the ID of the host
the IP address of the host
true if local storage is active, false otherwise
shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the host
the date and time the host was last pinged
the management server ID of the host
the amount of the host's memory currently allocated
the memory total of the host
the amount of the host's memory currently used
the name of the host
the incoming network traffic on the host
the outgoing network traffic on the host
the OS category ID of the host
the OS category name of the host
the Pod ID of the host
the Pod name of the host
the date and time the host was removed
the state of the host
the host type
the host version
the Zone ID of the host
the Zone name of the host
Lists all port forwarding rules for an IP address.
account. Must be used with the domainId parameter.
the domain ID. If used with the account parameter, lists port forwarding rules for the specified account in this domain.
Lists rule with the specified ID.
the id of IP address of the port forwarding services
the cidr list to forward traffic from
the ID of the port forwarding rule
the public ip address for the port forwarding rule
the public ip address id for the port forwarding rule
the ending port of port forwarding rule's private port range
the starting port of port forwarding rule's private port range
the protocol of the port forwarding rule
the starting port of port forwarding rule's public port range
the state of the rule
the VM display name for the port forwarding rule
the VM ID for the port forwarding rule
the VM name for the port forwarding rule
Creates a port forwarding rule
the IP address id of the port forwarding rule
the protocol for the port fowarding rule. Valid values are TCP or UDP.
the ID of the virtual machine for the port forwarding rule
if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default
Deletes a port forwarding rule
Creates a firewall rule for a given ip address
the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.
the ending port of firewall rule
error code for this icmp message
type of the icmp message being sent
the starting port of firewall rule
the ending port of firewall rule's port range
the ID of the firewall rule
the protocol of the firewall rule
the starting port of firewall rule's port range
Deletes a firewall rule
Lists all firewall rules for an IP address.
the domain ID. If used with the account parameter, lists firewall rules for the specified account in this domain.
the id of IP address of the firwall services
Lists all supported OS types for this cloud.
list by Os type Id
list by Os Category id
the name/description of the OS type
the ID of the OS type
the ID of the OS category
Lists all supported OS categories for this cloud.
list Os category by id
the name of the OS category
Adds a new host.
hypervisor type of the host
the password for the host
the host URL
the username for the host
the Zone ID for the host
Allocation state of this Host for allocation of new resources
the cluster ID for the host
the cluster name for the host
list of tags to be added to the host
the Pod ID for the host
Adds a new cluster
the cluster name
type of the cluster: CloudManaged, ExternalManaged
hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator
the Zone ID for the cluster
Allocation state of this cluster for allocation of new resources
the URL
the username for the cluster
the allocation state of the cluster
the type of the cluster
the hypervisor type of the cluster
the cluster ID
whether this cluster is managed by cloudstack
the Pod ID of the cluster
the Pod name of the cluster
the Zone ID of the cluster
the Zone name of the cluster
Deletes a cluster.
Updates an existing cluster
the ID of the Cluster
hypervisor type of the cluster
Reconnects a host.
the host ID
Updates a host.
the ID of the host to update
the id of Os category to update the host with
Deletes a host.
Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped
Force destroy local storage on this host. All VMs created on this local storage will be destroyed
Prepares a host for maintenance.
Cancels host maintenance.
Lists hosts.
list hosts by allocation state
lists hosts existing in particular cluster
give details. 1 = minimal; 2 = include static info; 3 = include events; 4 = include allocation and statistics
the id of the host
lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM
Adds secondary storage.
the URL for the secondary storage
the Zone ID for the secondary storage
Update password of a host/pool on management server.
the new password for the host/cluster
the username for the host/cluster
the cluster ID. Either this parameter, or hostId has to be passed in
the host ID. Either this parameter, or clusterId has to be passed in
Attaches an ISO to a virtual machine.
the ID of the ISO file
the ID of the virtual machine
the account associated with the virtual machine
the number of cpu this virtual machine is running with
the speed of each cpu
the amount of the vm's CPU currently used
the date when this virtual machine was created
user generated name. The name of the virtual machine is returned if no displayname exists.
the name of the domain in which the virtual machine exists
the ID of the domain in which the virtual machine exists
the virtual network for the service offering
the group name of the virtual machine
the group ID of the virtual machine
Os type ID of the virtual machine
true if high-availability is enabled, false otherwise
the ID of the host for the virtual machine
the name of the host for the virtual machine
the hypervisor on which the template runs
the ip address of the virtual machine
an alternate display text of the ISO attached to the virtual machine
the ID of the ISO attached to the virtual machine
the name of the ISO attached to the virtual machine
shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the virtual machine
the memory allocated for the virtual machine
the name of the virtual machine
the incoming network traffic on the vm
the list of nics associated with vm
the password (if exists) of the virtual machine
true if the password rest feature is enabled, false otherwise
device ID of the root volume
device type of the root volume
list of security groups associated with the virtual machine
the ID of the service offering of the virtual machine
the name of the service offering of the virtual machine
the state of the virtual machine
an alternate display text of the template for the virtual machine
the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
the name of the template for the virtual machine
the ID of the availablility zone for the virtual machine
the name of the availability zone for the virtual machine
Detaches any ISO file (if any) currently attached to a virtual machine.
The ID of the virtual machine
Lists all available ISO files.
the account of the ISO file. Must be used with the domainId parameter.
true if the ISO is bootable, false otherwise
lists all available ISO files by ID of a domain. If used with the account parameter, lists all available ISO files for the account in the ID of a domain.
the hypervisor for which to restrict the search
list all isos by id
possible values are "featured", "self", "self-executable","executable", and "community". * featured-ISOs that are featured and are publicself-ISOs that have been registered/created by the owner. * selfexecutable-ISOs that have been registered/created by the owner that can be used to deploy a new VM. * executable-all ISOs that can be used to deploy a new VM * community-ISOs that are public.
true if the ISO is publicly available to all users, false otherwise.
true if this ISO is ready to be deployed
list all isos by name
the ID of the zone
the account name to which the template belongs
the account id to which the template belongs
checksum of the template
the date this template was created
true if the template is managed across all Zones, false otherwise
additional key/value details tied with template
the template display text
the name of the domain to which the template belongs
the ID of the domain to which the template belongs
the format of the template.
the ID of the secondary storage host for the template
the name of the secondary storage host for the template
the template ID
true if the template is extractable, false otherwise
true if this template is a featured template, false otherwise
true if this template is a public template, false otherwise
true if the template is ready to be deployed from, false otherwise.
shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the template
the template name
the ID of the OS type for this template.
the name of the OS type for this template.
true if the reset password feature is enabled, false otherwise
the date this template was removed
the size of the template
the template ID of the parent template if present
the status of the template
the tag of this template
the type of the template
the ID of the zone for this template
the name of the zone for this template
Registers an existing ISO into the Cloud.com Cloud.
the display text of the ISO. This is usually used for display purposes.
the name of the ISO
the URL to where the ISO is currently being hosted
the ID of the zone you wish to register the ISO to.
an optional account name. Must be used with domainId.
true if this ISO is bootable
an optional domainId. If the account parameter is used, domainId must also be used.
true if the iso or its derivatives are extractable; default is false
true if you want this ISO to be featured
true if you want to register the ISO to be publicly available to all users, false otherwise.
the ID of the OS Type that best represents the OS of this ISO
Updates an ISO file.
the ID of the image file
true if image is bootable, false otherwise
the display text of the image
the format for the image
the name of the image file
the ID of the OS type that best represents the OS of this image.
true if the image supports the password reset feature; default is false
Deletes an ISO file.
the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones
Copies a template from one zone to another.
ID of the zone the template is being copied to.
Template ID.
ID of the zone the template is currently hosted on.
Updates iso permissions
a comma delimited list of accounts. If specified, "op" parameter has to be passed in.
true if the template/iso is extractable, false other wise. Can be set only by root admin
true for featured template/iso, false otherwise
true for public template/iso, false for private templates/isos
permission operator (add, remove, reset)
List template visibility and all accounts that have permissions to view this template.
List template visibility and permissions for the specified account. Must be used with the domainId parameter.
List template visibility and permissions by domain. If used with the account parameter, specifies in which domain the specified account exists.
the list of accounts the template is available for
Extracts an ISO
the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD
the ID of the zone where the ISO is originally located
the url to which the ISO would be extracted
the account id to which the extracted object belongs
the time and date the object was created
the upload id of extracted object
the mode of extraction - upload or download
the id of extracted object
the name of the extracted object
the state of the extracted object
the status of the extraction
type of the storage
the percentage of the entity uploaded to the specified location
if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded
zone ID the object was extracted from
zone name the object was extracted from
Updates resource limits for an account or domain.
Type of resource to update. Values are 0, 1, 2, 3, and 4. 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.
Update resource for a specified account. Must be used with the domainId parameter.
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.
Maximum resource limit.
the account of the resource limit
the domain name of the resource limit
the domain ID of the resource limit
the maximum number of the resource. A -1 means the resource currently has no limit.
resource type. Values include 0, 1, 2, 3, 4. See the resourceType parameter for more information on these values.
Recalculate and update resource count for an account or domain.
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.
Update resource count for a specified account. Must be used with the domainId parameter.
Type of resource to update. If specifies valid values are 0, 1, 2, 3, and 4. 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.
the account for which resource count's are updated
the domain name for which resource count's are updated
the domain ID for which resource count's are updated
resource count
Lists resource limits.
Lists resource limits by account. Must be used with the domainId parameter.
Lists resource limits by domain ID. If used with the account parameter, lists resource limits for a specified account in a specified domain.
Lists resource limits by ID.
Creates a load balancer rule
load balancer algorithm (source, roundrobin, leastconn)
name of the load balancer rule
the private port of the private ip address/virtual machine where the network traffic will be load balanced to
the public port from where the network traffic will be load balanced from
the account associated with the load balancer. Must be used with the domainId parameter.
the description of the load balancer rule
the domain ID associated with the load balancer
public ip address id from where the network traffic will be load balanced from
the account of the load balancer rule
the load balancer algorithm (source, roundrobin, leastconn)
the description of the load balancer
the domain of the load balancer rule
the domain ID of the load balancer rule
the load balancer rule ID
the name of the load balancer
the private port
the public ip address
the public ip address id
the public port
the id of the zone the rule belongs to
Deletes a load balancer rule.
the ID of the load balancer rule
Removes a virtual machine or a list of virtual machines from a load balancer rule.
The ID of the load balancer rule
the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)
Assigns virtual machine or a list of virtual machines to a load balancer rule.
the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)
Lists load balancer rules.
the account of the load balancer rule. Must be used with the domainId parameter.
the domain ID of the load balancer rule. If used with the account parameter, lists load balancer rules for the account in the specified domain.
the name of the load balancer rule
the public IP address id of the load balancer rule
the ID of the virtual machine of the load balancer rule
the availability zone ID
List all virtual machine instances that are assigned to a load balancer rule.
true if listing all virtual machines currently applied to the load balancer rule; default is true
Updates load balancer
the id of the load balancer rule to update
Enables static nat for given ip address
the public IP address id for which static nat feature is being enabled
the ID of the virtual machine for enabling static nat feature
Creates an ip forwarding rule
the public IP address id of the forwarding rule, already associated via associateIp
the protocol for the rule. Valid values are TCP or UDP.
the start port for the rule
the end port for the rule
Deletes an ip forwarding rule
the id of the forwarding rule
List the ip forwarding rules
the account associated with the ip forwarding rule. Must be used with the domainId parameter.
Lists all rules for this id. If used with the account parameter, returns all rules for an account in the specified domain ID.
list the rule belonging to this public ip address
Lists all rules applied to the specified Vm.
Disables static rule for given ip address
the public IP address id for which static nat feature is being disableed
Create a volume
aggregate name.
ip address.
password.
pool name.
volume size.
user name.
volume name.
snapshot policy.
snapshot reservation.
Destroy a Volume
List Volumes
Aggregate name
volume id
ip address
pool name
volume size
snapshot policy
snapshot reservation
Volume name
Create a LUN from a pool
LUN size.
iqn
pool path
Destroy a LUN
LUN path.
List LUN
lun id
lun iqn
lun name
Associate a LUN with a guest IQN
Guest IQN to which the LUN associate.
LUN name.
the LUN id
the IP address of
the target IQN
Dissociate a LUN
Guest IQN.
Create a pool
algorithm.
Delete a pool
Modify pool
List Pool
pool algorithm
pool id
Creates a network
the display text of the network
the name of the network
the network offering id
the Zone ID for the network
account who will own the network
domain ID of the account owning a network
the ending IP address in the network IP range. If not specified, will be defaulted to startIP
the gateway of the network
true if network is default, false otherwise
true is network is shared across accounts in the Zone
the netmask of the network
network domain
the beginning IP address in the network IP range
Tag the network
the ID or VID of the network
the owner of the network
Broadcast domain type of the network
broadcast uri of the network
the displaytext of the network
the first DNS for the network
the second DNS for the network
the domain name of the network owner
the domain id of the network owner
the end ip of the network
the network's gateway
the id of the network
true if network is shared, false otherwise
true if network is system, false otherwise
the network's netmask
availability of the network offering the network is created from
display text of the network offering the network is created from
network offering id the network is created from
name of the network offering the network is created from
related to what other network configuration
true if security group is enabled, false otherwise
the list of services
the start ip of the network
state of the network
comma separated tag
the traffic type of the network
the type of the network
the vlan of the network
zone id of the network
Deletes a network
the ID of the network
Lists all available networks.
account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited
domain ID of the account owning a VLAN
list networks by id
true if network is shared across accounts in the Zone, false otherwise
type of the traffic
the Zone ID of the network
Restarts the network; includes 1) restarting network elements - virtual routers, dhcp servers 2) reapplying all public ips 3) reapplying loadBalancing/portForwarding rules
The id of the network to restart.
If cleanup old network elements
Updates a network
the new display text for the network
the new name for the network
tags for the network
parameters for network device
Network device type, now supports ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer
the ID of the network device
List network device.
Delete network device.
Id of network device to delete
Updates a network offering.
the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering
the display text of the network offering
the id of the network offering
the name of the network offering
availability of the network offering
the date this network offering was created
an alternate display text of the network offering.
guest ip type of the network offering
true if network offering is default, false otherwise
the max number of concurrent connection the network offering supports
data transfer rate in megabits per second allowed.
true if network offering supports vlans, false otherwise
the tags for the network offering
the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.
Lists all available network offerings.
the availability of network offering. Default value is Required
list network offerings by display text
the guest ip type for the network offering, supported types are Direct and Virtual.
list network offerings by id
true if need to list only default network offerings. Default value is false
true is network offering supports vlans
list network offerings by name
the tags for the network offering.
list by traffic type
list netowrk offerings available for network creation in specific zone
List hypervisors
the zone id for listing hypervisors.
Hypervisor name
Creates a new Pod.
the gateway for the Pod
the name of the Pod
the netmask for the Pod
the starting IP address for the Pod
the Zone ID in which the Pod will be created
Allocation state of this Pod for allocation of new resources
the ending IP address for the Pod
the ending IP for the Pod
the gateway of the Pod
the ID of the Pod
the netmask of the Pod
the starting IP for the Pod
the Zone ID of the Pod
the Zone name of the Pod
Updates a Pod.
Deletes a Pod.
Lists all Pods.
list pods by allocation state
list Pods by ID
list Pods by name
list Pods by Zone ID
This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user
User id
the api key of the registered user
the secret key of the registered user
Starts a router.
the ID of the router
the account associated with the router
the date and time the router was created
the first DNS for the router
the second DNS for the router
the domain associated with the router
the domain ID associated with the router
the gateway for the router
the guest IP address for the router
the guest MAC address for the router
the guest netmask for the router
the ID of the corresponding guest network
the host ID for the router
the hostname for the router
the id of the router
if this router is an redundant virtual router
the link local IP address for the router
the link local MAC address for the router
the link local netmask for the router
the ID of the corresponding link local network
the name of the router
the network domain for the router
the Pod ID for the router
the public IP address for the router
the public MAC address for the router
the public netmask for the router
the ID of the corresponding public network
the state of redundant virtual router
the state of the router
the template ID for the router
the Zone ID for the router
the Zone name for the router
Stops a router.
Force stop the VM. The caller knows the VM is stopped.
Destroys a router.
Upgrades domain router to a new service offering
The ID of the router
the service offering ID to apply to the domain router
List routers.
the name of the account associated with the router. Must be used with the domainId parameter.
the domain ID associated with the router. If used with the account parameter, lists all routers associated with an account in the specified domain.
the host ID of the router
the ID of the disk router
list by network id
the Pod ID of the router
the Zone ID of the router
Register a public key in a keypair under a certain name
Name of the keypair
Public key material of the keypair
an optional account for the ssh key. Must be used with domainId.
an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.
Fingerprint of the public key
Private key
Create a new keypair and returns the private key
Deletes a keypair by name
the account associated with the keypair. Must be used with the domainId parameter.
the domain ID associated with the keypair
List registered keypairs
A public key fingerprint to look for
A key pair name to look for
Creates a security group
name of the security group
an optional account for the security group. Must be used with domainId.
the description of the security group
an optional domainId for the security group. If the account parameter is used, domainId must also be used.
the account owning the security group
the domain name of the security group
the domain ID of the security group
the ID of the security group
the list of ingress rules associated with the security group
the name of the security group
Deletes security group
the account of the security group. Must be specified with domain ID
the domain ID of account owning the security group
The ID of the security group. Mutually exclusive with name parameter
The ID of the security group. Mutually exclusive with id parameter
Authorizes a particular ingress rule for this security group
an optional account for the virtual machine. Must be used with domainId.
the cidr list associated
end port for this ingress rule
TCP is default. UDP is the other supported protocol
The ID of the security group. Mutually exclusive with securityGroupName parameter
The name of the security group. Mutually exclusive with securityGroupName parameter
start port for this ingress rule
user to security group mapping
account owning the ingress rule
the CIDR notation for the base IP address of the ingress rule
the ending IP of the ingress rule
the code for the ICMP message response
the type of the ICMP message response
the protocol of the ingress rule
the id of the ingress rule
security group name
the starting IP of the ingress rule
Deletes a particular ingress rule from this security group
The ID of the ingress rule
Lists security groups
lists all available port security groups for the account. Must be used with domainID parameter
lists all available security groups for the domain ID. If used with the account parameter, lists all available security groups for the account in the specified domain ID.
list the security group by the id provided
lists security groups by name
lists security groups by virtual machine id
Creates a service offering.
the CPU number of the service offering
the CPU speed of the service offering in MHz.
the display text of the service offering
the total memory of the service offering in MB
the name of the service offering
the host tag for this service offering.
is this a system vm offering
restrict the CPU usage to committed service offering
data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype
the HA for the service offering
the storage type of the service offering. Values are local and shared.
the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".
the tags for this service offering.
the number of CPU
the clock rate CPU speed in Mhz
the date this service offering was created
is this a default system vm offering
an alternate display text of the service offering.
Domain name for the offering
the domain id of the service offering
the host tag for the service offering
the id of the service offering
the memory in MB
the ha support in the service offering
the storage type for this service offering
is this a the systemvm type for system vm offering
the tags for the service offering
Deletes a service offering.
the ID of the service offering
Updates a service offering.
the ID of the service offering to be updated
the display text of the service offering to be updated
the name of the service offering to be updated
Lists all available service offerings.
the ID of the domain associated with the service offering
ID of the service offering
name of the service offering
the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".
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.
Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.
Username
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.
the account name the user belongs to
domain ID that the user belongs to
first name of the user
last name of the user
Password
Session key that can be passed in subsequent Query command calls
the time period before the session has expired
user time zone
user time zone offset from UTC 00:00
the account type (admin, domain-admin, read-only-admin, user)
Logs out the user
success if the logout action succeeded
Creates an instant snapshot of a volume.
The ID of the disk volume
The account of the snapshot. The account parameter must be used with the domainId parameter.
The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.
policy id of the snapshot, if this is null, then use MANUAL_POLICY.
the account associated with the snapshot
the date the snapshot was created
the domain name of the snapshot's account
the domain ID of the snapshot's account
ID of the snapshot
valid types are hourly, daily, weekly, monthy, template, and none.
the job ID associated with the snapshot. This is only displayed if the snapshot listed is part of a currently running asynchronous job.
the job status associated with the snapshot. This is only displayed if the snapshot listed is part of a currently running asynchronous job.
name of the snapshot
the type of the snapshot
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
ID of the disk volume
name of the disk volume
type of the disk volume
Lists all available snapshots for the account.
lists snapshot belongig to the specified account. Must be used with the domainId parameter.
the domain ID. If used with the account parameter, lists snapshots for the specified account in this domain.
lists snapshot by snapshot ID
valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.
defaults to false, but if true, lists all snapshots from the parent specified by the domain id till leaves.
lists snapshot by snapshot name
valid values are MANUAL or RECURRING.
the ID of the disk volume
Deletes a snapshot of a disk volume.
The ID of the snapshot
Creates a snapshot policy for the account.
valid values are HOURLY, DAILY, WEEKLY, and MONTHLY
maximum number of snapshots to retain
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)
the ID of the snapshot policy
the interval type of the snapshot policy
maximum number of snapshots retained
time the snapshot is scheduled to be taken.
the time zone of the snapshot policy
Deletes snapshot policies for the account.
the Id of the snapshot
list of snapshots IDs separated by comma
Lists snapshot policies.
lists snapshot policies for the specified account. Must be used with domainid parameter.
the domain ID. If used with the account parameter, lists snapshot policies for the specified account in this domain.
Lists storage pools.
list storage pools belongig to the specific cluster
the ID of the storage pool
the IP address for the storage pool
the name of the storage pool
the storage pool path
the Pod ID for the storage pool
the Zone ID for the storage pool
the ID of the cluster for the storage pool
the name of the cluster for the storage pool
the date and time the storage pool was created
the total disk size of the storage pool
the IP address of the storage pool
shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the storage pool
the Pod ID of the storage pool
the Pod name of the storage pool
the state of the storage pool
the tags for the storage pool
the storage pool type
the Zone ID of the storage pool
the Zone name of the storage pool
Creates a storage pool.
the name for the storage pool
the URL of the storage pool
the cluster ID for the storage pool
the details for the storage pool
Deletes a storage pool.
Storage pool id
Lists clusters.
lists clusters by allocation state
lists clusters by cluster type
lists clusters by hypervisor type
lists clusters by the cluster ID
lists clusters by the cluster name
lists clusters by Pod ID
lists clusters by Zone ID
Puts storage pool into maintenance state
Primary storage ID
Cancels maintenance for primary storage
the primary storage ID
Lists capacity.
lists capacity by the Host ID
lists capacity by the Pod ID
lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6
lists capacity by the Zone ID
the total capacity available
the capacity currently in use
the percentage of capacity currently in use
the Pod ID
the Pod name
the capacity type
the Zone ID
the Zone name
Starts a system virtual machine.
The ID of the system virtual machine
the number of active console sessions for the console proxy system vm
the date and time the system VM was created
the first DNS for the system VM
the second DNS for the system VM
the gateway for the system VM
the host ID for the system VM
the hostname for the system VM
the ID of the system VM
the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
the link local IP address for the system vm
the link local MAC address for the system vm
the link local netmask for the system vm
the name of the system VM
the network domain for the system VM
the Pod ID for the system VM
the private IP address for the system VM
the private MAC address for the system VM
the private netmask for the system VM
the public IP address for the system VM
the public MAC address for the system VM
the public netmask for the system VM
the state of the system VM
the system VM type
the template ID for the system VM
the Zone ID for the system VM
the Zone name for the system VM
Reboots a system VM.
Stops a system VM.
Destroyes a system virtual machine.
List system virtual machines.
the host ID of the system VM
the Pod ID of the system VM
the system VM type. Possible types are "consoleproxy" and "secondarystoragevm".
the Zone ID of the system VM
Attempts Migration of a system virtual machine to the host specified.
destination Host ID to migrate VM to
the role of the system VM
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.
the display text of the template. This is usually used for display purposes.
the name of the template
the ID of the OS Type that best represents the OS of this template.
32 or 64 bit
Template details in key/value pairs.
true if the template supports the password reset feature; default is false
true if the template requres HVM, false otherwise
the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in
the tag for this template.
Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server
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
the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in
Registers an existing template into the Cloud.com cloud.
the format for the template. Possible values include QCOW2, RAW, and VHD.
the target hypervisor for the template
the URL of where the template is hosted. Possible URL include http:// and https://
the ID of the zone the template is to be hosted on
an optional accountName. Must be used with domainId.
32 or 64 bits support. 64 by default
the MD5 checksum value of this template
true if the template or its derivatives are extractable; default is false
true if the template is available to all accounts; default is true
true if this template requires HVM
Updates attributes of a template.
Deletes a template from the system. All virtual machines using the deleted template will not be affected.
the ID of the template
the ID of zone of the template
List all public, private, and privileged templates.
possible values are "featured", "self", "self-executable", "executable", and "community".* featured-templates that are featured and are public* self-templates that have been registered/created by the owner* selfexecutable-templates that have been registered/created by the owner that can be used to deploy a new VM* executable-all templates that can be used to deploy a new VM* community-templates that are public.
list template by account. Must be used with the domainId parameter.
list all templates in specified domain. If used with the account parameter, lists all templates for an account in the specified domain.
list templates by zoneId
Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.
Extracts a template
load template into primary storage
template ID of the template to be prepared in primary storage(s).
zone ID of the template to be prepared in primary storage(s).
Adds Traffic Monitor Host for Direct Network Usage
URL of the traffic monitor Host
Deletes an traffic monitor host.
Id of the Traffic Monitor Host.
List traffic monitor Hosts.
Generates usage records
End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.
Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.
List events for the specified domain.
Lists usage records for accounts
List usage records for the specified user.
List usage records for the specified account
List usage records for the specified domain.
the user account name
the user account Id
the assign date of the account
description of account, including account name, service offering, and template
the domain ID number
end date of account
the IP address
source Nat flag for IPAddress
virtual machine name
service offering ID number
raw usage in hours
the release date of the account
start date of account
template ID number
type
usage in hours
id of the usage entity
usage type
virtual machine ID number
the zone ID number
Creates a user for an account that already exists
Creates the user under the specified domain. Has to be accompanied with the account parameter
Creates a user for an account
Deletes a user
Updates a user account
first name
last name
Hashed password (default is MD5). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapter
The API key for the user. Must be specified with userSecretKey
Unique username
The secret key for the user. Must be specified with userApiKey
Lists user accounts
List user by account. Must be used with the domainId parameter.
List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.
List all users in a domain. If used with the account parameter, lists an account in a specific domain.
List user by ID.
List users by state of the user account.
List user by the username
Disables a user account
Disables user by user ID.
Enables a user account
Enables user by user ID.
Creates a VLAN IP range.
the beginning IP address in the VLAN IP range
the ending IP address in the VLAN IP range
true if VLAN is of Virtual type, false if Direct
the gateway of the VLAN IP range
the netmask of the VLAN IP range
the network id
optional parameter. Have to be specified for Direct Untagged vlan only.
the ID or VID of the VLAN. Default is an "untagged" VLAN.
the Zone ID of the VLAN IP range
the account of the VLAN IP range
the description of the VLAN IP range
the domain name of the VLAN IP range
the domain ID of the VLAN IP range
the end ip of the VLAN IP range
the virtual network for the VLAN IP range
the ID of the VLAN IP range
the network id of vlan range
the Pod ID for the VLAN IP range
the Pod name for the VLAN IP range
the start ip of the VLAN IP range
the ID or VID of the VLAN.
the id of the VLAN IP range
Lists all VLAN IP ranges.
the account with which the VLAN IP range is associated. Must be used with the domainId parameter.
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.
network id of the VLAN IP range
the Pod ID of the VLAN IP range
Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
the ID of the service offering for the virtual machine
the ID of the template for the virtual machine
availability zone for the virtual machine
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.
an optional user generated name for the virtual machine
an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.
an optional group for the virtual machine
destination Host ID to deploy the VM to - parameter available for root admin only
the hypervisor on which to deploy the virtual machine
the ip address for default vm's network
ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].networkid=204 - requests to use ip 10.10.10.11 in network id=204
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
name of the ssh key pair used to login to the virtual machine
host name for the virtual machine
list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter
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
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
the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId
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. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.
Destroys a virtual machine. Once destroyed, only the administrator can recover it.
Reboots a virtual machine.
Starts a virtual machine.
Stops a virtual machine.
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]
Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.
the service offering ID to apply to the virtual machine
Updates parameters of a virtual machine.
user generated name
group of the virtual machine
true if high-availability is enabled for the virtual machine, false otherwise
the ID of the OS type that best represents this VM.
Recovers a virtual machine.
List the virtual machines owned by the account.
the domain ID. If used with the account parameter, lists virtual machines for the specified account in this domain.
list by network type; true if need to list vms using Virtual Network, false otherwise
the group ID
Must be used with domainId parameter. Defaults to false, but if true, lists all vms from the parent specified by the domain id till leaves.
name of the virtual machine
the pod ID
state of the virtual machine
the storage ID where vm's volumes belong to
Returns an encrypted password for the VM
The encrypted password of the VM
Attempts Migration of a user virtual machine to the host specified.
Creates a vm group
the name of the instance group
the account of the instance group. The account parameter must be used with the domainId parameter.
the domain ID of account owning the instance group
the account owning the instance group
time and date the instance group was created
the domain name of the instance group
the domain ID of the instance group
the id of the instance group
Deletes a vm group
the ID of the instance group
Updates a vm group
Instance group ID
new instance group name
Lists vm groups
list instance group belonging to the specified account. Must be used with domainid parameter
list instance groups by ID
list instance groups by name
Creates a l2tp/ipsec remote access vpn
public ip address id of the vpn server
an optional account for the VPN. Must be used with domainId.
an optional domainId for the VPN. If the account parameter is used, domainId must also be used.
the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server
the account of the remote access vpn
the domain id of the account of the remote access vpn
the domain name of the account of the remote access vpn
the range of ips to allocate to the clients
the ipsec preshared key
the public ip address of the vpn server
Destroys a l2tp/ipsec remote access vpn
Lists remote access vpns
the account of the remote access vpn. Must be used with the domainId parameter.
the domain ID of the remote access vpn rule. If used with the account parameter, lists remote access vpns for the account in the specified domain.
Adds vpn users
password for the username
username for the vpn user
an optional account for the vpn user. Must be used with domainId.
an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.
the vpn userID
the username of the vpn user
Removes vpn user
Lists vpn users
the domain ID of the remote access vpn. If used with the account parameter, lists remote access vpns for the account in the specified domain.
the ID of the vpn user
the username of the vpn user.
Attaches a disk volume to a virtual machine.
the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj
the account associated with the disk volume
the date the volume was attached to a VM instance
the date the disk volume was created
the boolean state of whether the volume is destroyed or not
the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
the display text of the disk offering
the domain associated with the disk volume
the ID of the domain associated with the disk volume
Hypervisor the volume belongs to
true if the volume is extractable, false otherwise
the display text of the service offering for root disk
ID of the service offering for root disk
name of the service offering for root disk
size of the disk volume
ID of the snapshot from which this volume was created
the state of the disk volume
name of the primary storage hosting the disk volume
shared or local storage
type of the disk volume (ROOT or DATADISK)
id of the virtual machine
display name of the virtual machine
ID of the availability zone
name of the availability zone
Detaches a disk volume from a virtual machine.
the device ID on the virtual machine where volume is detached from
the ID of the virtual machine where the volume is detached from
Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.
the name of the disk volume
the account associated with the disk volume. Must be used with the domainId parameter.
the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.
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.
Arbitrary volume size
the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.
the ID of the availability zone
Deletes a detached disk volume.
Lists all volumes.
Lists all disk volumes for the specified domain ID. If used with the account parameter, returns all disk volumes for an account in the specified domain ID.
list volumes on specified host
defaults to false, but if true, lists all volumes from the parent specified by the domain id till leaves.
the pod id the disk volume belongs to
the type of disk volume
Extracts volume
the ID of the volume
the ID of the zone where the volume is located
the url to which the volume would be extracted
Creates a Zone.
the first DNS for the Zone
the first internal DNS for the Zone
the name of the Zone
network type of the zone, can be Basic or Advanced
Allocation state of this Zone for allocation of new resources
the second DNS for the Zone
Network domain name for the networks in the zone
the ID of the containing domain, null for public zones
the guest CIDR address for the Zone
the second internal DNS for the Zone
true if network is security group enabled, false otherwise
the VLAN for the Zone
Zone description
the dhcp Provider for the Zone
the display text of the zone
Zone id
Zone name
the network type of the zone; can be Basic or Advanced
the vlan range of the zone
Zone Token
Updates a Zone.
the ID of the Zone
the details for the Zone
the dns search order list
updates a private zone to public if set, but not vice-versa
Deletes a Zone.
Lists zones
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.
the ID of the domain associated with the zone
See perlmodinstall for information and options on installing Perl modules.
Alan Young <harleypig@gmail.com>
This software is copyright (c) 2012 by Alan Young.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
To install Net::CloudStack::API, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::CloudStack::API
CPAN shell
perl -MCPAN -e shell install Net::CloudStack::API
For more information on module installation, please visit the detailed CPAN module installation guide.