http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addNicToVirtualMachine.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addNicToVirtualMachine.html b/source/api/apidocs-4.8/root_admin/addNicToVirtualMachine.html new file mode 100644 index 0000000..116ab27 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addNicToVirtualMachine.html @@ -0,0 +1,526 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addNicToVirtualMachine</h1> +<p>Adds VM to specified network by creating a NIC</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;"><strong>Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;"><strong>Virtual Machine ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>ipaddress</i></td><td style="width:500px;"><i>IP Address for the new network</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the number of cpu this virtual machine is running with</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the speed of each cpu</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the amount of the vm's CPU currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date when this virtual machine was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">Vm details in key/value pairs.</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskioread</strong></td><td style="width:500px;">the read (io) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskiowrite</strong></td><td style="width:500px;">the write (io) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskkbsread</strong></td><td style="width:500px;">the read (bytes) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskkbswrite</strong></td><td style="width:500px;">the write (bytes) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingid</strong></td><td style="width:500px;">the ID of the disk offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingname</strong></td><td style="width:500px;">the name of the disk offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>displayname</strong></td><td style="width:500px;">user generated name. The name of the virtual machine is returned if no displayname exists.</td> +</tr> +<tr> +<td style="width:200px;"><strong>displayvm</strong></td><td style="width:500px;">an optional field whether to the display the vm to the end user or not.</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the name of the domain in which the virtual machine exists</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain in which the virtual machine exists</td> +</tr> +<tr> +<td style="width:200px;"><strong>forvirtualnetwork</strong></td><td style="width:500px;">the virtual network for the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>group</strong></td><td style="width:500px;">the group name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>groupid</strong></td><td style="width:500px;">the group ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestosid</strong></td><td style="width:500px;">Os type ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>haenable</strong></td><td style="width:500px;">true if high-availability is enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the host for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the host for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor on which the template runs</td> +</tr> +<tr> +<td style="width:200px;"><strong>instancename</strong></td><td style="width:500px;">instance name of the user vm; this parameter is returned to the ROOT admin only</td> +</tr> +<tr> +<td style="width:200px;"><strong>isdynamicallyscalable</strong></td><td style="width:500px;">true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.</td> +</tr> +<tr> +<td style="width:200px;"><strong>isodisplaytext</strong></td><td style="width:500px;">an alternate display text of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>isoid</strong></td><td style="width:500px;">the ID of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>isoname</strong></td><td style="width:500px;">the name of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>keypair</strong></td><td style="width:500px;">ssh key-pair</td> +</tr> +<tr> +<td style="width:200px;"><strong>memory</strong></td><td style="width:500px;">the memory allocated for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbsread</strong></td><td style="width:500px;">the incoming network traffic on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbswrite</strong></td><td style="width:500px;">the outgoing network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">OS type id of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;">the password (if exists) of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>passwordenabled</strong></td><td style="width:500px;">true if the password rest feature is enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">public IP address id associated with vm via Static nat rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicipid</strong></td><td style="width:500px;">public IP address id associated with vm via Static nat rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>rootdeviceid</strong></td><td style="width:500px;">device ID of the root volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>rootdevicetype</strong></td><td style="width:500px;">device type of the root volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">the ID of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">the name of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>servicestate</strong></td><td style="width:500px;">State of the Service from LB rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatedisplaytext</strong></td><td style="width:500px;"> an alternate display text of the template for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateid</strong></td><td style="width:500px;">the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatename</strong></td><td style="width:500px;">the name of the template for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>userid</strong></td><td style="width:500px;">the user's ID who deployed the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the user's name who deployed the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>vgpu</strong></td><td style="width:500px;">the vgpu type used by the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the availablility zone for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the availability zone for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroup(*)</strong></td><td style="width:500px;">list of affinity groups associated with the virtual machine</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account owning the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>description</strong></td><td style="width:500px;">the description of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the type of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineIds</strong></td><td style="width:500px;">virtual machine IDs associated with this affinity group</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with vm</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>broadcasturi</strong></td><td style="width:500px;">the broadcast uri of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>deviceid</strong></td><td style="width:500px;">device id for the network when plugged into the virtual machine</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6address</strong></td><td style="width:500px;">the IPv6 address of network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6cidr</strong></td><td style="width:500px;">the cidr of IPv6 network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6gateway</strong></td><td style="width:500px;">the gateway of IPv6 network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ipaddress</strong></td><td style="width:500px;">the ip address of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>isdefault</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>isolationuri</strong></td><td style="width:500px;">the isolation uri of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>macaddress</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>networkid</strong></td><td style="width:500px;">the ID of the corresponding network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>networkname</strong></td><td style="width:500px;">the name of the corresponding network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitch</strong></td><td style="width:500px;">Id of the NSX Logical Switch (if NSX based), null otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitchport</strong></td><td style="width:500px;">Id of the NSX Logical Switch Port (if NSX based), null otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>secondaryip</strong></td><td style="width:500px;">the Secondary ipv4 addr of nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>traffictype</strong></td><td style="width:500px;">the traffic type of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the type of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineid</strong></td><td style="width:500px;">Id of the vm to which the nic belongs</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroup(*)</strong></td><td style="width:500px;">list of security groups associated with the virtual machine</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account owning the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>description</strong></td><td style="width:500px;">the description of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the name of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name of the group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachinecount</strong></td><td style="width:500px;">the number of virtualmachines associated with this securitygroup</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineids</strong></td><td style="width:500px;">the list of virtualmachine ids associated with this securitygroup</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>egressrule(*)</strong></td><td style="width:500px;">the list of egress rules associated with the security group</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">cidr</td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">endport</td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmpcode</td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmptype</td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">protocol</td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">ruleid</td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">securitygroupname</td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">startport</td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">tags(*)</td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ingressrule(*)</strong></td><td style="width:500px;">the list of ingress rules associated with the security group</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">cidr</td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">endport</td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmpcode</td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmptype</td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">protocol</td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">ruleid</td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">securitygroupname</td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">startport</td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">tags(*)</td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">customer</td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">domain</td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">domainid</td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">key</td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">project</td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">projectid</td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">resourceid</td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">resourcetype</td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">value</td><td style="width:500px;">tag value</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with vm</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addNiciraNvpDevice.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addNiciraNvpDevice.html b/source/api/apidocs-4.8/root_admin/addNiciraNvpDevice.html new file mode 100644 index 0000000..eb0a905 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addNiciraNvpDevice.html @@ -0,0 +1,121 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addNiciraNvpDevice</h1> +<p>Adds a Nicira NVP device</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;"><strong>Hostname of ip address of the Nicira NVP Controller.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>Credentials to access the Nicira Controller API</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the Physical Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>transportzoneuuid</strong></td><td style="width:500px;"><strong>The Transportzone UUID configured on the Nicira Controller</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>Credentials to access the Nicira Controller API</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>l2gatewayserviceuuid</i></td><td style="width:500px;"><i>The L2 Gateway Service UUID configured on the Nicira Controller</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>l3gatewayserviceuuid</i></td><td style="width:500px;"><i>The L3 Gateway Service UUID configured on the Nicira Controller</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the controller Ip address</td> +</tr> +<tr> +<td style="width:200px;"><strong>l2gatewayserviceuuid</strong></td><td style="width:500px;">this L2 gateway service Uuid</td> +</tr> +<tr> +<td style="width:200px;"><strong>l3gatewayserviceuuid</strong></td><td style="width:500px;">this L3 gateway service Uuid</td> +</tr> +<tr> +<td style="width:200px;"><strong>niciradevicename</strong></td><td style="width:500px;">device name</td> +</tr> +<tr> +<td style="width:200px;"><strong>nvpdeviceid</strong></td><td style="width:500px;">device id of the Nicire Nvp</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network to which this Nirica Nvp belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">name of the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>transportzoneuuid</strong></td><td style="width:500px;">the transport zone Uuid</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addNuageVspDevice.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addNuageVspDevice.html b/source/api/apidocs-4.8/root_admin/addNuageVspDevice.html new file mode 100644 index 0000000..07f3d74 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addNuageVspDevice.html @@ -0,0 +1,127 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addNuageVspDevice</h1> +<p>Adds a Nuage VSP device</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>apiversion</strong></td><td style="width:500px;"><strong>the version of the API to use to communicate to Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;"><strong>the hostname of the Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>the password of CMS user in Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the ID of the physical network in to which Nuage VSP is added</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>port</strong></td><td style="width:500px;"><strong>the port to communicate to Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>retrycount</strong></td><td style="width:500px;"><strong>the number of retries on failure to communicate to Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>retryinterval</strong></td><td style="width:500px;"><strong>the time to wait after failure before retrying to communicate to Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>the user name of the CMS user in Nuage VSD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>apiversion</strong></td><td style="width:500px;">the version of the API to use to communicate to Nuage VSD</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the hostname of the Nuage VSD</td> +</tr> +<tr> +<td style="width:200px;"><strong>nuagedevicename</strong></td><td style="width:500px;">the name of the Nuage VSP device</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the ID of the physical network to which this Nuage VSP belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>port</strong></td><td style="width:500px;">the port to communicate to Nuage VSD</td> +</tr> +<tr> +<td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">the service provider name corresponding to this Nuage VSP device</td> +</tr> +<tr> +<td style="width:200px;"><strong>retrycount</strong></td><td style="width:500px;">the number of retries on failure to communicate to Nuage VSD</td> +</tr> +<tr> +<td style="width:200px;"><strong>retryinterval</strong></td><td style="width:500px;">the time to wait after failure before retrying to communicate to Nuage VSD</td> +</tr> +<tr> +<td style="width:200px;"><strong>vspdeviceid</strong></td><td style="width:500px;">the device id of the Nuage VSD</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addOpenDaylightController.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addOpenDaylightController.html b/source/api/apidocs-4.8/root_admin/addOpenDaylightController.html new file mode 100644 index 0000000..d5908aa --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addOpenDaylightController.html @@ -0,0 +1,103 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addOpenDaylightController</h1> +<p>Adds an OpenDyalight controler</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>Credential to access the OpenDaylight API</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the Physical Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>Api URL of the OpenDaylight Controller.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>Username to access the OpenDaylight API</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">device id of the controller</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name assigned to the controller</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network to which this controller belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">the url of the controller api</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the username to authenticate to the controller</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addPaloAltoFirewall.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addPaloAltoFirewall.html b/source/api/apidocs-4.8/root_admin/addPaloAltoFirewall.html new file mode 100644 index 0000000..ae2a7f5 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addPaloAltoFirewall.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addPaloAltoFirewall</h1> +<p>Adds a Palo Alto firewall device</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkdevicetype</strong></td><td style="width:500px;"><strong>supports only PaloAltoFirewall</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>Credentials to reach Palo Alto firewall device</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the Physical Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>URL of the Palo Alto appliance.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>Credentials to reach Palo Alto firewall device</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicecapacity</strong></td><td style="width:500px;">device capacity</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdeviceid</strong></td><td style="width:500px;">device id of the Palo Alto firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicename</strong></td><td style="width:500px;">device name</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicestate</strong></td><td style="width:500px;">device state</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the management IP address of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>numretries</strong></td><td style="width:500px;">the number of times to retry requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network to which this Palo Alto firewall belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>privateinterface</strong></td><td style="width:500px;">the private interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>privatezone</strong></td><td style="width:500px;">the private security zone of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">name of the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicinterface</strong></td><td style="width:500px;">the public interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>publiczone</strong></td><td style="width:500px;">the public security zone of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>timeout</strong></td><td style="width:500px;">the timeout (in seconds) for requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>usageinterface</strong></td><td style="width:500px;">the usage interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the username that's used to log in to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the zone ID of the external firewall</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addRegion.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addRegion.html b/source/api/apidocs-4.8/root_admin/addRegion.html new file mode 100644 index 0000000..5413fe6 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addRegion.html @@ -0,0 +1,100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addRegion</h1> +<p>Adds a Region</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>Id of the Region</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>endpoint</strong></td><td style="width:500px;"><strong>Region service endpoint</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>Name of the region</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the region</td> +</tr> +<tr> +<td style="width:200px;"><strong>endpoint</strong></td><td style="width:500px;">the end point of the region</td> +</tr> +<tr> +<td style="width:200px;"><strong>gslbserviceenabled</strong></td><td style="width:500px;">true if GSLB service is enabled in the region, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the region</td> +</tr> +<tr> +<td style="width:200px;"><strong>portableipserviceenabled</strong></td><td style="width:500px;">true if security groups support is enabled, false otherwise</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addResourceDetail.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addResourceDetail.html b/source/api/apidocs-4.8/root_admin/addResourceDetail.html new file mode 100644 index 0000000..a71f00d --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addResourceDetail.html @@ -0,0 +1,94 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addResourceDetail</h1> +<p>Adds detail for the Resource.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;"><strong>Map of (key/value pairs)</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>resourceid</strong></td><td style="width:500px;"><strong>resource id to create the details for</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>resourcetype</strong></td><td style="width:500px;"><strong>type of the resource</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>fordisplay</i></td><td style="width:500px;"><i>pass false if you want this detail to be disabled for the regular user. True by default</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addSecondaryStorage.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addSecondaryStorage.html b/source/api/apidocs-4.8/root_admin/addSecondaryStorage.html new file mode 100644 index 0000000..81e223d --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addSecondaryStorage.html @@ -0,0 +1,109 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addSecondaryStorage</h1> +<p>Adds secondary storage.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>the URL for the secondary storage</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the Zone ID for the secondary storage</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">the details of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>providername</strong></td><td style="width:500px;">the provider name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>scope</strong></td><td style="width:500px;">the scope of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">the url of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the image store</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addSrxFirewall.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addSrxFirewall.html b/source/api/apidocs-4.8/root_admin/addSrxFirewall.html new file mode 100644 index 0000000..a5edb21 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addSrxFirewall.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addSrxFirewall</h1> +<p>Adds a SRX firewall device</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkdevicetype</strong></td><td style="width:500px;"><strong>supports only JuniperSRXFirewall</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>Credentials to reach SRX firewall device</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the Physical Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>URL of the SRX appliance.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>Credentials to reach SRX firewall device</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicecapacity</strong></td><td style="width:500px;">device capacity</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdeviceid</strong></td><td style="width:500px;">device id of the SRX firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicename</strong></td><td style="width:500px;">device name</td> +</tr> +<tr> +<td style="width:200px;"><strong>fwdevicestate</strong></td><td style="width:500px;">device state</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the management IP address of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>numretries</strong></td><td style="width:500px;">the number of times to retry requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network to which this SRX firewall belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>privateinterface</strong></td><td style="width:500px;">the private interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>privatezone</strong></td><td style="width:500px;">the private security zone of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">name of the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicinterface</strong></td><td style="width:500px;">the public interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>publiczone</strong></td><td style="width:500px;">the public security zone of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>timeout</strong></td><td style="width:500px;">the timeout (in seconds) for requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>usageinterface</strong></td><td style="width:500px;">the usage interface of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the username that's used to log in to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the zone ID of the external firewall</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addStratosphereSsp.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addStratosphereSsp.html b/source/api/apidocs-4.8/root_admin/addStratosphereSsp.html new file mode 100644 index 0000000..db6bba9 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addStratosphereSsp.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addStratosphereSsp</h1> +<p>Adds stratosphere ssp server</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>stratosphere ssp api name</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>stratosphere ssp server url</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;"><strong>the zone ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>password</i></td><td style="width:500px;"><i>stratosphere ssp api password</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>tenantuuid</i></td><td style="width:500px;"><i>stratosphere ssp tenant uuid</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>username</i></td><td style="width:500px;"><i>stratosphere ssp api username</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">server id of the stratosphere ssp server</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">url of ssp endpoint</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone which this ssp controls</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addSwift.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addSwift.html b/source/api/apidocs-4.8/root_admin/addSwift.html new file mode 100644 index 0000000..4f28b52 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addSwift.html @@ -0,0 +1,115 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addSwift</h1> +<p>Adds Swift.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>the URL for swift</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the account for swift</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>key</i></td><td style="width:500px;"><i> key for the user for swift</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>username</i></td><td style="width:500px;"><i>the username for swift</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">the details of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>providername</strong></td><td style="width:500px;">the provider name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>scope</strong></td><td style="width:500px;">the scope of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">the url of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the image store</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addTrafficMonitor.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addTrafficMonitor.html b/source/api/apidocs-4.8/root_admin/addTrafficMonitor.html new file mode 100644 index 0000000..8770195 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addTrafficMonitor.html @@ -0,0 +1,103 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addTrafficMonitor</h1> +<p>Adds Traffic Monitor Host for Direct Network Usage</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>URL of the traffic monitor Host</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;"><strong>Zone in which to add the external firewall appliance.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>excludezones</i></td><td style="width:500px;"><i>Traffic going into the listed zones will not be metered</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>includezones</i></td><td style="width:500px;"><i>Traffic going into the listed zones will be metered</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the management IP address of the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>numretries</strong></td><td style="width:500px;">the number of times to retry requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>timeout</strong></td><td style="width:500px;">the timeout (in seconds) for requests to the external firewall</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the zone ID of the external firewall</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/addTrafficType.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/addTrafficType.html b/source/api/apidocs-4.8/root_admin/addTrafficType.html new file mode 100644 index 0000000..739fe1d --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/addTrafficType.html @@ -0,0 +1,127 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>addTrafficType</h1> +<p>Adds traffic type to a physical network</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>the Physical Network ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>traffictype</strong></td><td style="width:500px;"><strong>the trafficType to be added to the physical network</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>hypervnetworklabel</i></td><td style="width:500px;"><i>The network name label of the physical device dedicated to this traffic on a Hyperv host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isolationmethod</i></td><td style="width:500px;"><i>Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>kvmnetworklabel</i></td><td style="width:500px;"><i>The network name label of the physical device dedicated to this traffic on a KVM host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ovm3networklabel</i></td><td style="width:500px;"><i>The network name of the physical device dedicated to this traffic on an OVM3 host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>vlan</i></td><td style="width:500px;"><i>The VLAN id to be used for Management traffic by VMware host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>vmwarenetworklabel</i></td><td style="width:500px;"><i>The network name label of the physical device dedicated to this traffic on a VMware host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>xennetworklabel</i></td><td style="width:500px;"><i>The network name label of the physical device dedicated to this traffic on a XenServer host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">id of the network provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervnetworklabel</strong></td><td style="width:500px;">The network name label of the physical device dedicated to this traffic on a HyperV host</td> +</tr> +<tr> +<td style="width:200px;"><strong>kvmnetworklabel</strong></td><td style="width:500px;">The network name label of the physical device dedicated to this traffic on a KVM host</td> +</tr> +<tr> +<td style="width:200px;"><strong>ovm3networklabel</strong></td><td style="width:500px;">The network name of the physical device dedicated to this traffic on an OVM3 host</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network this belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>traffictype</strong></td><td style="width:500px;">the trafficType to be added to the physical network</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmwarenetworklabel</strong></td><td style="width:500px;">The network name label of the physical device dedicated to this traffic on a VMware host</td> +</tr> +<tr> +<td style="width:200px;"><strong>xennetworklabel</strong></td><td style="width:500px;">The network name label of the physical device dedicated to this traffic on a XenServer host</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
