Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id E662F1830D for ; Wed, 17 Feb 2016 02:34:20 +0000 (UTC) Received: (qmail 23131 invoked by uid 500); 17 Feb 2016 02:34:17 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 22782 invoked by uid 500); 17 Feb 2016 02:34:16 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 21439 invoked by uid 99); 17 Feb 2016 02:34:15 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Feb 2016 02:34:15 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 8389BE5714; Wed, 17 Feb 2016 02:34:15 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pdion891@apache.org To: commits@cloudstack.apache.org Date: Wed, 17 Feb 2016 02:34:25 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [11/51] [partial] cloudstack-www git commit: 4.8.0 with APIs, change copyright date to 2016 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createProject.html b/source/api/apidocs-4.8/root_admin/createProject.html new file mode 100644 index 0000000..cce6711 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createProject.html @@ -0,0 +1,247 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createProject

+

Creates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextdisplay text of the projecttrue
namename of the projecttrue
accountaccount who will be Admin for the projectfalse
domainiddomain ID of the account owning a projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the project
accountthe account name of the project's owner
cpuavailablethe total number of cpu cores available to be created for this project
cpulimitthe total number of cpu cores the project can own
cputotalthe total number of cpu cores owned by project
displaytextthe displaytext of the project
domainthe domain name where the project belongs to
domainidthe domain id the project belongs to
ipavailablethe total number of public ip addresses available for this project to acquire
iplimitthe total number of public ip addresses this project can acquire
iptotalthe total number of public ip addresses allocated for this project
memoryavailablethe total memory (in MB) available to be created for this project
memorylimitthe total memory (in MB) the project can own
memorytotalthe total memory (in MB) owned by project
namethe name of the project
networkavailablethe total number of networks available to be created for this project
networklimitthe total number of networks the project can own
networktotalthe total number of networks owned by project
primarystorageavailablethe total primary storage space (in GiB) available to be used for this project
primarystoragelimitthe total primary storage space (in GiB) the project can own
primarystoragetotalthe total primary storage space (in GiB) owned by project
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitthe total secondary storage space (in GiB) the project can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by project
snapshotavailablethe total number of snapshots available for this project
snapshotlimitthe total number of snapshots which can be stored by this project
snapshottotalthe total number of snapshots stored by this project
statethe state of the project
templateavailablethe total number of templates available to be created by this project
templatelimitthe total number of templates which can be created by this project
templatetotalthe total number of templates which have been created by this project
vmavailablethe total number of virtual machines available for this project to acquire
vmlimitthe total number of virtual machines that can be deployed by this project
vmrunningthe total number of virtual machines running for this project
vmstoppedthe total number of virtual machines stopped for this project
vmtotalthe total number of virtual machines deployed by this project
volumeavailablethe total volume available for this project
volumelimitthe total volume which can be used by this project
volumetotalthe total volume being used by this project
vpcavailablethe total number of vpcs available to be created for this project
vpclimitthe total number of vpcs the project can own
vpctotalthe total number of vpcs owned by project
tags(*)the list of resource tags associated with vm
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createRemoteAccessVpn.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createRemoteAccessVpn.html b/source/api/apidocs-4.8/root_admin/createRemoteAccessVpn.html new file mode 100644 index 0000000..d7f7bf6 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createRemoteAccessVpn.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createRemoteAccessVpn

+

Creates a l2tp/ipsec remote access vpn

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
publicipidpublic ip address id of the vpn servertrue
accountan optional account for the VPN. Must be used with domainId.false
domainidan optional domainId for the VPN. If the account parameter is used, domainId must also be used.false
fordisplayan optional field, whether to the display the vpn to the end user or notfalse
iprangethe range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn serverfalse
openfirewallif true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by defaultfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the remote access vpn
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
fordisplayis vpn for display to the regular user
iprangethe range of ips to allocate to the clients
presharedkeythe ipsec preshared key
projectthe project name of the vpn
projectidthe project id of the vpn
publicipthe public ip address of the vpn server
publicipidthe public ip address of the vpn server
statethe state of the rule
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createSSHKeyPair.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createSSHKeyPair.html b/source/api/apidocs-4.8/root_admin/createSSHKeyPair.html new file mode 100644 index 0000000..88fa527 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createSSHKeyPair.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createSSHKeyPair

+

Create a new keypair and returns the private key

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
nameName of the keypairtrue
accountan optional account for the ssh key. Must be used with domainId.false
domainidan optional domainId for the ssh key. If the account parameter is used, domainId must also be used.false
projectidan optional project for the ssh keyfalse
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
privatekeyPrivate key
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createSecondaryStagingStore.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createSecondaryStagingStore.html b/source/api/apidocs-4.8/root_admin/createSecondaryStagingStore.html new file mode 100644 index 0000000..5bc5ce6 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createSecondaryStagingStore.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createSecondaryStagingStore

+

create secondary staging store.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
urlthe URL for the staging storetrue
detailsthe details for the staging storefalse
providerthe staging store provider namefalse
scopethe scope of the staging store: zone only for nowfalse
zoneidthe Zone ID for the staging storefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the image store
detailsthe details of the image store
namethe name of the image store
protocolthe protocol of the image store
providernamethe provider name of the image store
scopethe scope of the image store
urlthe url of the image store
zoneidthe Zone ID of the image store
zonenamethe Zone name of the image store
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createSecurityGroup.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createSecurityGroup.html b/source/api/apidocs-4.8/root_admin/createSecurityGroup.html new file mode 100644 index 0000000..f2da108 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createSecurityGroup.html @@ -0,0 +1,286 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createSecurityGroup

+

Creates a security group

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
namename of the security grouptrue
accountan optional account for the security group. Must be used with domainId.false
descriptionthe description of the security groupfalse
domainidan optional domainId for the security group. If the account parameter is used, domainId must also be used.false
projectidCreate security group for projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the security group
accountthe account owning the security group
descriptionthe description of the security group
domainthe domain name of the security group
domainidthe domain ID of the security group
namethe name of the security group
projectthe project name of the group
projectidthe project id of the group
virtualmachinecountthe number of virtualmachines associated with this securitygroup
virtualmachineidsthe list of virtualmachine ids associated with this securitygroup
egressrule(*)the list of egress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
ingressrule(*)the list of ingress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createServiceInstance.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createServiceInstance.html b/source/api/apidocs-4.8/root_admin/createServiceInstance.html new file mode 100644 index 0000000..29ee3a4 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createServiceInstance.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createServiceInstance

+

Creates a system virtual-machine that implements network services

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
leftnetworkidThe left (inside) network for service instancetrue
nameThe name of the service instancetrue
rightnetworkidThe right (outside) network ID for the service instancetrue
serviceofferingidThe service offering ID that defines the resources consumed by the service appliancetrue
templateidThe template ID that specifies the image for the service appliancetrue
zoneidAvailability zone for the service instancetrue
accountAn optional account for the virtual machine. Must be used with domainId.false
domainidAn optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.false
projectidProject ID for the service instancefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
namethe name of the virtual machine
projectthe project name of the vm
projectidthe project id of the vm
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createServiceOffering.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createServiceOffering.html b/source/api/apidocs-4.8/root_admin/createServiceOffering.html new file mode 100644 index 0000000..b9c8b47 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createServiceOffering.html @@ -0,0 +1,247 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createServiceOffering

+

Creates a service offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextthe display text of the service offeringtrue
namethe name of the service offeringtrue
bytesreadratebytes read rate of the disk offeringfalse
byteswriteratebytes write rate of the disk offeringfalse
cpunumberthe CPU number of the service offeringfalse
cpuspeedthe CPU speed of the service offering in MHz.false
customizediopswhether compute offering iops is custom or notfalse
deploymentplannerThe deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is usedfalse
domainidthe ID of the containing domain, null for public offeringsfalse
hosttagsthe host tag for this service offering.false
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateio requests read rate of the disk offeringfalse
iopswriterateio requests write rate of the disk offeringfalse
issystemis this a system vm offeringfalse
isvolatiletrue 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 VMfalse
limitcpuuserestrict the CPU usage to committed service offeringfalse
maxiopsmax iops of the compute offeringfalse
memorythe total memory of the service offering in MBfalse
miniopsmin iops of the compute offeringfalse
networkratedata transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtypefalse
offerhathe HA for the service offeringfalse
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.false
serviceofferingdetailsdetails for planner, used to store specific parametersfalse
storagetypethe storage type of the service offering. Values are local and shared.false
systemvmtypethe system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".false
tagsthe tags for this service offering.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the service offering
cpunumberthe number of CPU
cpuspeedthe clock rate CPU speed in Mhz
createdthe date this service offering was created
defaultuseis this a default system vm offering
deploymentplannerdeployment strategy used to deploy VM.
diskBytesReadRatebytes read rate of the service offering
diskBytesWriteRatebytes write rate of the service offering
diskIopsReadRateio requests read rate of the service offering
diskIopsWriteRateio requests write rate of the service offering
displaytextan alternate display text of the service offering.
domainDomain name for the offering
domainidthe domain id of the service offering
hosttagsthe host tag for the service offering
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedis true if the offering is customized
iscustomizediopstrue if disk offering uses custom iops, false otherwise
issystemis this a system vm offering
isvolatiletrue 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
limitcpuuserestrict the CPU usage to committed service offering
maxiopsthe max iops of the disk offering
memorythe memory in MB
miniopsthe min iops of the disk offering
namethe name of the service offering
networkratedata transfer rate in megabits per second allowed.
offerhathe ha support in the service offering
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.
serviceofferingdetailsadditional key/value details tied with this service offering
storagetypethe storage type for this service offering
systemvmtypeis this a the systemvm type for system vm offering
tagsthe tags for the service offering
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createSnapshot.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createSnapshot.html b/source/api/apidocs-4.8/root_admin/createSnapshot.html new file mode 100644 index 0000000..cf13b82 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createSnapshot.html @@ -0,0 +1,184 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createSnapshot

+

Creates an instant snapshot of a volume.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
volumeidThe ID of the disk volumetrue
accountThe account of the snapshot. The account parameter must be used with the domainId parameter.false
domainidThe domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.false
namethe name of the snapshotfalse
policyidpolicy id of the snapshot, if this is null, then use MANUAL_POLICY.false
quiescevmquiesce vm if truefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the snapshot
accountthe account associated with the snapshot
created the date the snapshot was created
domainthe domain name of the snapshot's account
domainidthe domain ID of the snapshot's account
intervaltypevalid types are hourly, daily, weekly, monthy, template, and none.
namename of the snapshot
physicalsizephysical size of backedup snapshot on image store
projectthe project name of the snapshot
projectidthe project id of the snapshot
revertableindicates whether the underlying storage supports reverting the volume to this snapshot
snapshottypethe type of the snapshot
statethe 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
volumeidID of the disk volume
volumenamename of the disk volume
volumetypetype of the disk volume
zoneidid of the availability zone
tags(*)the list of resource tags associated with snapshot
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createSnapshotPolicy.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createSnapshotPolicy.html b/source/api/apidocs-4.8/root_admin/createSnapshotPolicy.html new file mode 100644 index 0000000..90f567e --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createSnapshotPolicy.html @@ -0,0 +1,115 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createSnapshotPolicy

+

Creates a snapshot policy for the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
intervaltypevalid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
maxsnapsmaximum number of snapshots to retaintrue
scheduletime 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)true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.true
volumeidthe ID of the disk volumetrue
fordisplayan optional field, whether to the display the policy to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the snapshot policy
fordisplayis this policy for display to the regular user
intervaltypethe interval type of the snapshot policy
maxsnapsmaximum number of snapshots retained
scheduletime the snapshot is scheduled to be taken.
timezonethe time zone of the snapshot policy
volumeidthe ID of the disk volume
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createStaticRoute.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createStaticRoute.html b/source/api/apidocs-4.8/root_admin/createStaticRoute.html new file mode 100644 index 0000000..c1ee571 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createStaticRoute.html @@ -0,0 +1,145 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createStaticRoute

+

Creates a static route

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
cidrstatic route cidrtrue
gatewayidthe gateway id we are creating static route fortrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of static route
accountthe account associated with the static route
cidrstatic route CIDR
domainthe domain associated with the static route
domainidthe ID of the domain associated with the static route
gatewayidVPC gateway the route is created for
projectthe project name of the static route
projectidthe project id of the static route
statethe state of the static route
vpcidVPC the static route belongs to
tags(*)the list of resource tags associated with static route
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createStorageNetworkIpRange.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createStorageNetworkIpRange.html b/source/api/apidocs-4.8/root_admin/createStorageNetworkIpRange.html new file mode 100644 index 0000000..c09ccf2 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createStorageNetworkIpRange.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

+

createStorageNetworkIpRange

+

Creates a Storage network IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
gatewaythe gateway for storage networktrue
netmaskthe netmask for storage networktrue
podidUUID of pod where the ip range belongs totrue
startipthe beginning IP addresstrue
endipthe ending IP addressfalse
vlanOptional. The vlan the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type tablefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe uuid of storage network IP range.
endipthe end ip of the storage network IP range
gatewaythe gateway of the storage network IP range
netmaskthe netmask of the storage network IP range
networkidthe network uuid of storage network IP range
podidthe Pod uuid for the storage network IP range
startipthe start ip of the storage network IP range
vlanthe ID or VID of the VLAN.
zoneidthe Zone uuid of the storage network IP range
+
+
+
+
+
+ +
+
+ +