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 8CE6E17E9F for ; Tue, 17 Nov 2015 13:40:22 +0000 (UTC) Received: (qmail 8700 invoked by uid 500); 17 Nov 2015 13:40:21 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 7778 invoked by uid 500); 17 Nov 2015 13:40:20 -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 7131 invoked by uid 99); 17 Nov 2015 13:40:19 -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; Tue, 17 Nov 2015 13:40:19 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id ADFB9DFF87; Tue, 17 Nov 2015 13:40:19 +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: Tue, 17 Nov 2015 13:40:29 -0000 Message-Id: In-Reply-To: <22fd21d5896f4c5ebda5acb07bcadd93@git.apache.org> References: <22fd21d5896f4c5ebda5acb07bcadd93@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [11/53] [partial] cloudstack-www git commit: 4.6.0 is out! http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createStoragePool.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createStoragePool.html b/content/api/apidocs-4.6/root_admin/createStoragePool.html new file mode 100644 index 0000000..e8abc74 --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createStoragePool.html @@ -0,0 +1,190 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createStoragePool

+

Creates a storage pool.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
namethe name for the storage pooltrue
urlthe URL of the storage pooltrue
zoneidthe Zone ID for the storage pooltrue
capacitybytesbytes CloudStack can provision from this storage poolfalse
capacityiopsIOPS CloudStack can provision from this storage poolfalse
clusteridthe cluster ID for the storage poolfalse
detailsthe details for the storage poolfalse
hypervisorhypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.false
managedwhether the storage should be managed by CloudStackfalse
podidthe Pod ID for the storage poolfalse
providerthe storage provider namefalse
scopethe scope of the storage: cluster or zonefalse
tagsthe tags for the storage poolfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the storage pool
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridthe ID of the cluster for the storage pool
clusternamethe name of the cluster for the storage pool
createdthe date and time the storage pool was created
disksizeallocatedthe host's currently allocated disk size
disksizetotalthe total disk size of the storage pool
disksizeusedthe host's currently used disk size
hypervisorthe hypervisor type of the storage pool
ipaddressthe IP address of the storage pool
namethe name of the storage pool
overprovisionfactorthe overprovisionfactor for the storage pool
paththe storage pool path
podidthe Pod ID of the storage pool
podnamethe Pod name of the storage pool
scopethe scope of the storage pool
statethe state of the storage pool
storagecapabilitiesthe storage pool capabilities
suitableformigrationtrue if this pool is suitable to migrate a volume, false otherwise
tagsthe tags for the storage pool
typethe storage pool type
zoneidthe Zone ID of the storage pool
zonenamethe Zone name of the storage pool
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/dc20554d/content/api/apidocs-4.6/root_admin/createTags.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createTags.html b/content/api/apidocs-4.6/root_admin/createTags.html new file mode 100644 index 0000000..6e1a5c6 --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createTags.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createTags

+

Creates resource tag(s)

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourceidslist of resources to create the tags fortrue
resourcetypetype of the resourcetrue
tagsMap of tags (key/value pairs)true
customeridentifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internallyfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createTemplate.html b/content/api/apidocs-4.6/root_admin/createTemplate.html new file mode 100644 index 0000000..0810d6c --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createTemplate.html @@ -0,0 +1,268 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createTemplate

+

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.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextthe display text of the template. This is usually used for display purposes.true
namethe name of the templatetrue
ostypeidthe ID of the OS Type that best represents the OS of this template.true
bits32 or 64 bitfalse
detailsTemplate details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
isdynamicallyscalabletrue if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memoryfalse
isfeaturedtrue if this template is a featured template, false otherwisefalse
ispublictrue if this template is a public template, false otherwisefalse
passwordenabledtrue if the template supports the password reset feature; default is falsefalse
projectidcreate template for the projectfalse
requireshvmtrue if the template requres HVM, false otherwisefalse
snapshotidthe ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed infalse
templatetagthe tag for this template.false
urlOptional, only for baremetal hypervisor. The directory name where template stored on CIFS serverfalse
virtualmachineidOptional, 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 BareMetalfalse
volumeidthe ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed infalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe template ID
accountthe account name to which the template belongs
accountidthe account id to which the template belongs
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
detailsadditional key/value details tied with template
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
formatthe format of the template.
hostidthe ID of the secondary storage host for the template
hostnamethe name of the secondary storage host for the template
hypervisorthe hypervisor on which the template runs
isdynamicallyscalabletrue if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractabletrue if the template is extractable, false otherwise
isfeaturedtrue if this template is a featured template, false otherwise
ispublictrue if this template is a public template, false otherwise
isreadytrue if the template is ready to be deployed from, false otherwise.
namethe template name
ostypeidthe ID of the OS type for this template.
ostypenamethe name of the OS type for this template.
passwordenabledtrue if the reset password feature is enabled, false otherwise
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
sizethe size of the template
sourcetemplateidthe template ID of the parent template if present
sshkeyenabledtrue if template is sshkey enabled, false otherwise
statusthe status of the template
templatetagthe tag of this template
templatetypethe type of the template
zoneidthe ID of the zone for this template
zonenamethe name of the zone for this template
tags(*)the list of resource tags associated with tempate
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/dc20554d/content/api/apidocs-4.6/root_admin/createUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createUser.html b/content/api/apidocs-4.6/root_admin/createUser.html new file mode 100644 index 0000000..2c4ce4e --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createUser.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createUser

+

Creates a user for an account that already exists

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountCreates the user under the specified account. If no account is specified, the username will be used as the account name.true
emailemailtrue
firstnamefirstnametrue
lastnamelastnametrue
passwordClear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.true
usernameUnique username.true
domainidCreates the user under the specified domain. Has to be accompanied with the account parameterfalse
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.false
useridUser UUID, required for adding account from external provisioning systemfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createVMSnapshot.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createVMSnapshot.html b/content/api/apidocs-4.6/root_admin/createVMSnapshot.html new file mode 100644 index 0000000..05f2078 --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createVMSnapshot.html @@ -0,0 +1,142 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createVMSnapshot

+

Creates snapshot for a vm.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the vmtrue
descriptionThe description of the snapshotfalse
nameThe display name of the snapshotfalse
quiescevmquiesce vm if truefalse
snapshotmemorysnapshot memory if truefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the vm snapshot
accountthe account associated with the disk volume
createdthe create date of the vm snapshot
currentindiates if this is current snapshot
descriptionthe description of the vm snapshot
displaynamethe display name of the vm snapshot
domainthe domain associated with the disk volume
domainidthe ID of the domain associated with the disk volume
namethe name of the vm snapshot
parentthe parent ID of the vm snapshot
parentNamethe parent displayName of the vm snapshot
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the vm snapshot
typeVM Snapshot type
virtualmachineidthe vm ID of the vm snapshot
zoneidthe Zone ID of the vm snapshot
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createVPC.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createVPC.html b/content/api/apidocs-4.6/root_admin/createVPC.html new file mode 100644 index 0000000..ff4d76b --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createVPC.html @@ -0,0 +1,430 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createVPC

+

Creates a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
cidrthe cidr of the VPC. All VPC guest networks' cidrs should be within this CIDRtrue
displaytextthe display text of the VPCtrue
namethe name of the VPCtrue
vpcofferingidthe ID of the VPC offeringtrue
zoneidthe ID of the availability zonetrue
accountthe account associated with the VPC. Must be used with the domainId parameter.false
domainidthe domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.false
fordisplayan optional field, whether to the display the vpc to the end user or notfalse
networkdomainVPC network domain. All networks inside the VPC will belong to this domainfalse
projectidcreate VPC for the projectfalse
startIf set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the VPC
accountthe owner of the VPC
cidrthe cidr the VPC
createdthe date this VPC was created
displaytextan alternate display text of the VPC.
distributedvpcrouteris VPC uses distributed router for one hop forwarding and host based network ACL's
domainthe domain name of the owner
domainidthe domain id of the VPC owner
fordisplayis vpc for display to the regular user
namethe name of the VPC
networkdomainthe network domain of the VPC
projectthe project name of the VPC
projectidthe project id of the VPC
redundantvpcrouterif this VPC has redundant router
regionlevelvpctrue if VPC is region level
restartrequiredtrue VPC requires restart
statestate of the VPC. Can be Inactive/Enabled
vpcofferingidvpc offering id the VPC is created from
zoneidzone id of the vpc
zonenamethe name of the zone the VPC belongs to
network(*)the list of networks belongign to the VPC
idthe id of the network
accountthe owner of the network
aclidACL Id associated with the VPC network
acltypeacl type - access type to the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploylist networks available for vm deployment
cidrCloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
displaynetworkan optional field, whether to the display the network to the end user or not.
displaytextthe displaytext of the network
dns1the first DNS for the network
dns2the second DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
gatewaythe network's gateway
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
isdefaulttrue if network is default, false otherwise
ispersistentlist networks that are persistent
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkcidrthe network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingconservemodetrue if network offering is ip conserve mode enabled
networkofferingdisplaytextdisplay text of the network offering the network is created from
networkofferingidnetwork offering id the network is created from
networkofferingnamename of the network offering the network is created from
physicalnetworkidthe physical network id
projectthe project name of the address
projectidthe project id of the ipaddress
relatedrelated to what other network configuration
reservediprangethe network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
strechedl2subnettrue if network can span multiple zones
subdomainaccesstrue if users from subdomains can access the domain level network
traffictypethe traffic type of the network
typethe type of the network
vlanThe vlan of the network. This parameter is visible to ROOT admins only
vpcidVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
zonesnetworkspansIf a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
service(*)the list of services
namethe service name
capability(*)the list of capabilities
provider(*)the service provider name
tags(*)the list of resource tags associated with network
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
service(*)the list of supported services
namethe service name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
provider(*)the service provider name
iduuid of the network provider
canenableindividualservicetrue if individual services can be enabled/disabled
destinationphysicalnetworkidthe destination physical network
namethe provider name
physicalnetworkidthe physical network this belongs to
servicelistservices for this provider
statestate of the network provider
tags(*)the list of resource tags associated with the project
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/dc20554d/content/api/apidocs-4.6/root_admin/createVPCOffering.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createVPCOffering.html b/content/api/apidocs-4.6/root_admin/createVPCOffering.html new file mode 100644 index 0000000..6d300dc --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createVPCOffering.html @@ -0,0 +1,160 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createVPCOffering

+

Creates VPC offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextthe display text of the vpc offeringtrue
namethe name of the vpc offeringtrue
supportedservicesservices supported by the vpc offeringtrue
servicecapabilitylistdesired service capabilities as part of vpc offeringfalse
serviceofferingidthe ID of the service offering for the VPC router appliancefalse
serviceproviderlistprovider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the vpc offering
createdthe date this vpc offering was created
displaytextan alternate display text of the vpc offering.
distributedvpcrouter indicates if the vpc offering supports distributed router for one-hop forwarding
isdefaulttrue if vpc offering is default, false otherwise
namethe name of the vpc offering
statestate of the vpc offering. Can be Disabled/Enabled
supportsregionLevelvpc indicated if the offering can support region level vpc
service(*)the list of supported services
namethe service name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
provider(*)the service provider name
iduuid of the network provider
canenableindividualservicetrue if individual services can be enabled/disabled
destinationphysicalnetworkidthe destination physical network
namethe provider name
physicalnetworkidthe physical network this belongs to
servicelistservices for this provider
statestate of the network provider
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createVirtualRouterElement.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createVirtualRouterElement.html b/content/api/apidocs-4.6/root_admin/createVirtualRouterElement.html new file mode 100644 index 0000000..f936ae0 --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createVirtualRouterElement.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createVirtualRouterElement

+

Create a virtual router element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nspidthe network service provider ID of the virtual router elementtrue
providertypeThe provider type. Supported types are VirtualRouter (default) and VPCVirtualRouterfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the router
accountthe account associated with the provider
domainthe domain associated with the provider
domainidthe domain ID associated with the provider
enabledEnabled/Disabled the service provider
nspidthe physical network service provider id of the provider
projectthe project name of the address
projectidthe project id of the ipaddress
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/root_admin/createVlanIpRange.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/root_admin/createVlanIpRange.html b/content/api/apidocs-4.6/root_admin/createVlanIpRange.html new file mode 100644 index 0000000..e1693fe --- /dev/null +++ b/content/api/apidocs-4.6/root_admin/createVlanIpRange.html @@ -0,0 +1,193 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.6.0 Root Admin API Reference + +

+

createVlanIpRange

+

Creates a VLAN IP range.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountaccount who will own the VLAN. If VLAN is Zone wide, this parameter should be ommitedfalse
domainiddomain ID of the account owning a VLANfalse
endipthe ending IP address in the VLAN IP rangefalse
endipv6the ending IPv6 address in the IPv6 network rangefalse
forvirtualnetworktrue if VLAN is of Virtual type, false if Directfalse
gatewaythe gateway of the VLAN IP rangefalse
ip6cidrthe CIDR of IPv6 network, must be at least /64false
ip6gatewaythe gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPCfalse
netmaskthe netmask of the VLAN IP rangefalse
networkidthe network idfalse
physicalnetworkidthe physical network idfalse
podidoptional parameter. Have to be specified for Direct Untagged vlan only.false
projectidproject who will own the VLAN. If VLAN is Zone wide, this parameter should be ommitedfalse
startipthe beginning IP address in the VLAN IP rangefalse
startipv6the beginning IPv6 address in the IPv6 network rangefalse
vlanthe ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untaggedfalse
zoneidthe Zone ID of the VLAN IP rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the VLAN IP range
accountthe account of the VLAN IP range
descriptionthe description of the VLAN IP range
domainthe domain name of the VLAN IP range
domainidthe domain ID of the VLAN IP range
endipthe end ip of the VLAN IP range
endipv6the end ipv6 of the VLAN IP range
forvirtualnetworkthe virtual network for the VLAN IP range
gatewaythe gateway of the VLAN IP range
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
netmaskthe netmask of the VLAN IP range
networkidthe network id of vlan range
physicalnetworkidthe physical network this belongs to
podidthe Pod ID for the VLAN IP range
podnamethe Pod name for the VLAN IP range
projectthe project name of the vlan range
projectidthe project id of the vlan range
startipthe start ip of the VLAN IP range
startipv6the start ipv6 of the VLAN IP range
vlanthe ID or VID of the VLAN.
zoneidthe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ +