In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [48/51] [partial] cloudstack-www git commit: Adding API html pages http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/copyIso.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/copyIso.html b/source/api/apidocs-4.0.0/domain_admin/copyIso.html new file mode 100644 index 0000000..69bd7b1 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/copyIso.html @@ -0,0 +1,217 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

copyIso

Copies a template from one zone to another.

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	Template ID.	true
destzoneid	ID of the zone the template is being copied to.	true
sourcezoneid	ID of the zone the template is currently hosted on.	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/copyTemplate.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/copyTemplate.html b/source/api/apidocs-4.0.0/domain_admin/copyTemplate.html new file mode 100644 index 0000000..24d65ed --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/copyTemplate.html @@ -0,0 +1,217 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

copyTemplate

Copies a template from one zone to another.

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	Template ID.	true
destzoneid	ID of the zone the template is being copied to.	true
sourcezoneid	ID of the zone the template is currently hosted on.	true

Response Tags

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createFirewallRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createFirewallRule.html b/source/api/apidocs-4.0.0/domain_admin/createFirewallRule.html new file mode 100644 index 0000000..734974d --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createFirewallRule.html @@ -0,0 +1,157 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createFirewallRule

Creates a firewall rule for a given ip address

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
ipaddressid	the IP address id of the port forwarding rule	true
protocol	the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.	true
cidrlist	the cidr list to forward traffic from	false
endport	the ending port of firewall rule	false
icmpcode	error code for this icmp message	false
icmptype	type of the icmp message being sent	false
startport	the starting port of firewall rule	false
type	type of firewallrule: system/user	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the firewall rule
cidrlist	the cidr list to forward traffic from
endport	the ending port of firewall rule's port range
icmpcode	error code for this icmp message
icmptype	type of the icmp message being sent
ipaddress	the public ip address for the firewall rule
ipaddressid	the public ip address id for the firewall rule
protocol	the protocol of the firewall rule
startport	the starting port of firewall rule's port range
state	the state of the rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createInstanceGroup.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createInstanceGroup.html b/source/api/apidocs-4.0.0/domain_admin/createInstanceGroup.html new file mode 100644 index 0000000..0f5bb75 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createInstanceGroup.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createInstanceGroup

Creates a vm group

+ +

Request parameters

+ + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
name	the name of the instance group	true
account	the account of the instance group. The account parameter must be used with the domainId parameter.	false
domainid	the domain ID of account owning the instance group	false
projectid	The project of the instance group	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the instance group
account	the account owning the instance group
created	time and date the instance group was created
domain	the domain name of the instance group
domainid	the domain ID of the instance group
name	the name of the instance group
project	the project name of the group
projectid	the project id of the group

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createIpForwardingRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createIpForwardingRule.html b/source/api/apidocs-4.0.0/domain_admin/createIpForwardingRule.html new file mode 100644 index 0000000..153e728 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createIpForwardingRule.html @@ -0,0 +1,160 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createIpForwardingRule

Creates an ip forwarding rule

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
ipaddressid	the public IP address id of the forwarding rule, already associated via associateIp	true
protocol	the protocol for the rule. Valid values are TCP or UDP.	true
startport	the start port for the rule	true
cidrlist	the cidr list to forward traffic from	false
endport	the end port for the rule	false
openfirewall	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	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
privateendport	the ending port of port forwarding rule's private port range
privateport	the starting port of port forwarding rule's private port range
protocol	the protocol of the port forwarding rule
publicendport	the ending port of port forwarding rule's private port range
publicport	the starting port of port forwarding rule's public port range
state	the state of the rule
virtualmachinedisplayname	the VM display name for the port forwarding rule
virtualmachineid	the VM ID for the port forwarding rule
virtualmachinename	the VM name for the port forwarding rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createLBStickinessPolicy.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createLBStickinessPolicy.html b/source/api/apidocs-4.0.0/domain_admin/createLBStickinessPolicy.html new file mode 100644 index 0000000..d4e9bab --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createLBStickinessPolicy.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createLBStickinessPolicy

Creates a Load Balancer stickiness policy

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
lbruleid	the ID of the load balancer rule	true
methodname	name of the LB Stickiness policy method, possible values can be obtained from ListNetworks API	true
name	name of the LB Stickiness policy	true
description	the description of the LB Stickiness policy	false
param	param list. Example: param[0].name=cookiename&param[0].value=LBCookie	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
account	the account of the Stickiness policy
description	the description of the Stickiness policy
domain	the domain of the Stickiness policy
domainid	the domain ID of the Stickiness policy
lbruleid	the LB rule ID
name	the name of the Stickiness policy
state	the state of the policy
zoneid	the id of the zone the Stickiness policy belongs to
*stickinesspolicy()**	the list of stickinesspolicies
id	the LB Stickiness policy ID
description	the description of the Stickiness policy
methodname	the method name of the Stickiness policy
name	the name of the Stickiness policy
params	the params of the policy
state	the state of the policy

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createLoadBalancerRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createLoadBalancerRule.html b/source/api/apidocs-4.0.0/domain_admin/createLoadBalancerRule.html new file mode 100644 index 0000000..69f2c66 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createLoadBalancerRule.html @@ -0,0 +1,187 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createLoadBalancerRule

Creates a load balancer rule

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
algorithm	load balancer algorithm (source, roundrobin, leastconn)	true
name	name of the load balancer rule	true
privateport	the private port of the private ip address/virtual machine where the network traffic will be load balanced to	true
publicport	the public port from where the network traffic will be load balanced from	true
account	the account associated with the load balancer. Must be used with the domainId parameter.	false
cidrlist	the cidr list to forward traffic from	false
description	the description of the load balancer rule	false
domainid	the domain ID associated with the load balancer	false
networkid	The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)	false
openfirewall	if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true	false
publicipid	public ip address id from where the network traffic will be load balanced from	false
zoneid	zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the load balancer rule ID
account	the account of the load balancer rule
algorithm	the load balancer algorithm (source, roundrobin, leastconn)
cidrlist	the cidr list to forward traffic from
description	the description of the load balancer
domain	the domain of the load balancer rule
domainid	the domain ID of the load balancer rule
name	the name of the load balancer
privateport	the private port
project	the project name of the load balancer
projectid	the project id of the load balancer
publicip	the public ip address
publicipid	the public ip address id
publicport	the public port
state	the state of the rule
zoneid	the id of the zone the rule belongs to
*tags()**	the list of resource tags associated with load balancer
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createNetwork.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createNetwork.html b/source/api/apidocs-4.0.0/domain_admin/createNetwork.html new file mode 100644 index 0000000..fc07fbd --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createNetwork.html @@ -0,0 +1,283 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createNetwork

Creates a network

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	the display text of the network	true
name	the name of the network	true
networkofferingid	the network offering id	true
zoneid	the Zone ID for the network	true
account	account who will own the network	false
acltype	Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all Isolated networks - Account. Account means that only the account owner can use the network, domain - all accouns in the domain can use the network	false
domainid	domain ID of the account owning a network	false
endip	the ending IP address in the network IP range. If not specified, will be defaulted to startIP	false
gateway	the gateway of the network. Required for Shared networks and Isolated networks when it belongs to VPC	false
netmask	the netmask of the network. Required for Shared networks and Isolated networks when it belongs to VPC	false
networkdomain	network domain	false
physicalnetworkid	the Physical Network ID the network belongs to	false
projectid	an optional project for the ssh key	false
startip	the beginning IP address in the network IP range	false
subdomainaccess	Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified	false
vlan	the ID or VID of the network	false
vpcid	the VPC network belongs to	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the network
account	the owner of the network
acltype	acl type - access type to the network
broadcastdomaintype	Broadcast domain type of the network
broadcasturi	broadcast uri of the network
canusefordeploy	list networks available for vm deployment
cidr	the cidr the network
displaytext	the displaytext of the network
dns1	the first DNS for the network
dns2	the second DNS for the network
domain	the domain name of the network owner
domainid	the domain id of the network owner
gateway	the network's gateway
isdefault	true if network is default, false otherwise
issystem	true if network is system, false otherwise
name	the name of the network
netmask	the network's netmask
networkdomain	the network domain
networkofferingavailability	availability of the network offering the network is created from
networkofferingdisplaytext	display text of the network offering the network is created from
networkofferingid	network offering id the network is created from
networkofferingname	name of the network offering the network is created from
physicalnetworkid	the physical network id
project	the project name of the address
projectid	the project id of the ipaddress
related	related to what other network configuration
restartrequired	true network requires restart
specifyipranges	true if network supports specifying ip ranges, false otherwise
state	state of the network
subdomainaccess	true if users from subdomains can access the domain level network
traffictype	the traffic type of the network
type	the type of the network
vlan	the vlan of the network
vpcid	VPC the network belongs to
zoneid	zone id of the network
zonename	the name of the zone the network belongs to
*service()**	the list of services
name	the service name
provider	the service provider name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*tags()**	the list of resource tags associated with network
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createNetworkACL.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createNetworkACL.html b/source/api/apidocs-4.0.0/domain_admin/createNetworkACL.html new file mode 100644 index 0000000..40282e5 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createNetworkACL.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createNetworkACL

Creates a ACL rule the given network (the network has to belong to VPC)

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
networkid	The network of the vm the ACL will be created for	true
protocol	the protocol for the ACL rule. Valid values are TCP/UDP/ICMP.	true
cidrlist	the cidr list to allow traffic from/to	false
endport	the ending port of ACL	false
icmpcode	error code for this icmp message	false
icmptype	type of the icmp message being sent	false
startport	the starting port of ACL	false
traffictype	the traffic type for the ACL,can be Ingress or Egress, defaulted to Ingress if not specified	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the ACL
cidrlist	the cidr list to forward traffic from
endport	the ending port of ACL's port range
icmpcode	error code for this icmp message
icmptype	type of the icmp message being sent
protocol	the protocol of the ACL
startport	the starting port of ACL's port range
state	the state of the rule
traffictype	the traffic type for the ACL
*tags()**	the list of resource tags associated with the network ACLs
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createPortForwardingRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createPortForwardingRule.html b/source/api/apidocs-4.0.0/domain_admin/createPortForwardingRule.html new file mode 100644 index 0000000..e42e61b --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createPortForwardingRule.html @@ -0,0 +1,172 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createPortForwardingRule

Creates a port forwarding rule

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
ipaddressid	the IP address id of the port forwarding rule	true
privateport	the starting port of port forwarding rule's private port range	true
protocol	the protocol for the port fowarding rule. Valid values are TCP or UDP.	true
publicport	the starting port of port forwarding rule's public port range	true
virtualmachineid	the ID of the virtual machine for the port forwarding rule	true
cidrlist	the cidr list to forward traffic from	false
networkid	The network of the vm the Port Forwarding rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)	false
openfirewall	if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true	false
privateendport	the ending port of port forwarding rule's private port range	false
publicendport	the ending port of port forwarding rule's private port range	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
privateendport	the ending port of port forwarding rule's private port range
privateport	the starting port of port forwarding rule's private port range
protocol	the protocol of the port forwarding rule
publicendport	the ending port of port forwarding rule's private port range
publicport	the starting port of port forwarding rule's public port range
state	the state of the rule
virtualmachinedisplayname	the VM display name for the port forwarding rule
virtualmachineid	the VM ID for the port forwarding rule
virtualmachinename	the VM name for the port forwarding rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/createProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/createProject.html b/source/api/apidocs-4.0.0/domain_admin/createProject.html new file mode 100644 index 0000000..6241cb3 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/createProject.html @@ -0,0 +1,136 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

createProject

Creates a project

+ +

Request parameters

+ + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	display text of the project	true
name	name of the project	true
account	account who will be Admin for the project	false
domainid	domain ID of the account owning a project	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the project
account	the account name of the project's owner
displaytext	the displaytext of the project
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
name	the name of the project
state	the state of the project
*tags()**	the list of resource tags associated with vm
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +