http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/changeServiceForRouter.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/changeServiceForRouter.html b/source/api/apidocs-4.9/apis/changeServiceForRouter.html new file mode 100644 index 0000000..82a1937 --- /dev/null +++ b/source/api/apidocs-4.9/apis/changeServiceForRouter.html @@ -0,0 +1,280 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

changeServiceForRouter

+

Upgrades domain router to a new service offering

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the routertrue
serviceofferingidthe service offering ID to apply to the domain routertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the router
accountthe account associated with the router
createdthe date and time the router was created
dns1the first DNS for the router
dns2the second DNS for the router
domainthe domain associated with the router
domainidthe domain ID associated with the router
gatewaythe gateway for the router
guestipaddressthe guest IP address for the router
guestmacaddressthe guest MAC address for the router
guestnetmaskthe guest netmask for the router
guestnetworkidthe ID of the corresponding guest network
guestnetworknamethe name of the corresponding guest network
hostidthe host ID for the router
hostnamethe hostname for the router
hypervisorthe hypervisor on which the template runs
ip6dns1the first IPv6 DNS for the router
ip6dns2the second IPv6 DNS for the router
isredundantrouterif this router is an redundant virtual router
linklocalipthe link local IP address for the router
linklocalmacaddressthe link local MAC address for the router
linklocalnetmaskthe link local netmask for the router
linklocalnetworkidthe ID of the corresponding link local network
namethe name of the router
networkdomainthe network domain for the router
podidthe Pod ID for the router
projectthe project name of the address
projectidthe project id of the ipaddress
publicipthe public IP address for the router
publicmacaddressthe public MAC address for the router
publicnetmaskthe public netmask for the router
publicnetworkidthe ID of the corresponding public network
redundantstatethe state of redundant virtual router
requiresupgradetrue if the router template requires upgrader
rolerole of the domain router
scriptsversionthe version of scripts
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
statethe state of the router
templateidthe template ID for the router
versionthe version of template
vpcidVPC the router belongs to
vpcnamethe name of VPC the router belongs to
zoneidthe Zone ID for the router
zonenamethe Zone name for the router
nic(*)the list of nics associated with the router
idthe ID of the nic
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/changeServiceForSystemVm.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/changeServiceForSystemVm.html b/source/api/apidocs-4.9/apis/changeServiceForSystemVm.html new file mode 100644 index 0000000..f281baa --- /dev/null +++ b/source/api/apidocs-4.9/apis/changeServiceForSystemVm.html @@ -0,0 +1,169 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

changeServiceForSystemVm

+

Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the system vmtrue
serviceofferingidthe service offering ID to apply to the system vmtrue
detailsname value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the system VM
activeviewersessionsthe number of active console sessions for the console proxy system vm
createdthe date and time the system VM was created
dns1the first DNS for the system VM
dns2the second DNS for the system VM
gatewaythe gateway for the system VM
hostidthe host ID for the system VM
hostnamethe hostname for the system VM
hypervisorthe hypervisor on which the template runs
jobidthe job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
jobstatusthe job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
linklocalipthe link local IP address for the system vm
linklocalmacaddressthe link local MAC address for the system vm
linklocalnetmaskthe link local netmask for the system vm
namethe name of the system VM
networkdomainthe network domain for the system VM
podidthe Pod ID for the system VM
privateipthe private IP address for the system VM
privatemacaddressthe private MAC address for the system VM
privatenetmaskthe private netmask for the system VM
publicipthe public IP address for the system VM
publicmacaddressthe public MAC address for the system VM
publicnetmaskthe public netmask for the system VM
statethe state of the system VM
systemvmtypethe system VM type
templateidthe template ID for the system VM
zoneidthe Zone ID for the system VM
zonenamethe Zone name for the system VM
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/changeServiceForVirtualMachine.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/changeServiceForVirtualMachine.html b/source/api/apidocs-4.9/apis/changeServiceForVirtualMachine.html new file mode 100644 index 0000000..aa1842d --- /dev/null +++ b/source/api/apidocs-4.9/apis/changeServiceForVirtualMachine.html @@ -0,0 +1,502 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

changeServiceForVirtualMachine

+

Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the virtual machinetrue
serviceofferingidthe service offering ID to apply to the virtual machinetrue
detailsname value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
cpunumberthe number of cpu this virtual machine is running with
cpuspeedthe speed of each cpu
cpuusedthe amount of the vm's CPU currently used
createdthe date when this virtual machine was created
detailsVm details in key/value pairs.
diskioreadthe read (io) of disk on the vm
diskiowritethe write (io) of disk on the vm
diskkbsreadthe read (bytes) of disk on the vm
diskkbswritethe write (bytes) of disk on the vm
diskofferingidthe ID of the disk offering of the virtual machine
diskofferingnamethe name of the disk offering of the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
displayvman optional field whether to the display the vm to the end user or not.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
forvirtualnetworkthe virtual network for the service offering
groupthe group name of the virtual machine
groupidthe group ID of the virtual machine
guestosidOs type ID of the virtual machine
haenabletrue if high-availability is enabled, false otherwise
hostidthe ID of the host for the virtual machine
hostnamethe name of the host for the virtual machine
hypervisorthe hypervisor on which the template runs
instancenameinstance name of the user vm; this parameter is returned to the ROOT admin only
isdynamicallyscalabletrue if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
isodisplaytextan alternate display text of the ISO attached to the virtual machine
isoidthe ID of the ISO attached to the virtual machine
isonamethe name of the ISO attached to the virtual machine
keypairssh key-pair
memorythe memory allocated for the virtual machine
memoryintfreekbsthe internal memory thats free in vm
memorykbsthe memory used by the vm
memorytargetkbsthe target memory in vm
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
ostypeidOS type id of the vm
passwordthe password (if exists) of the virtual machine
passwordenabledtrue if the password rest feature is enabled, false otherwise
projectthe project name of the vm
projectidthe project id of the vm
publicippublic IP address id associated with vm via Static nat rule
publicipidpublic IP address id associated with vm via Static nat rule
rootdeviceiddevice ID of the root volume
rootdevicetypedevice type of the root volume
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
servicestateState of the Service from LB rule
statethe state of the virtual machine
templatedisplaytext an alternate display text of the template for the virtual machine
templateidthe ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatenamethe name of the template for the virtual machine
useridthe user's ID who deployed the virtual machine
usernamethe user's name who deployed the virtual machine
vgputhe vgpu type used by the virtual machine
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
affinitygroup(*)list of affinity groups associated with the virtual machine
idthe ID of the affinity group
accountthe account owning the affinity group
descriptionthe description of the affinity group
domainthe domain name of the affinity group
domainidthe domain ID of the affinity group
namethe name of the affinity group
projectthe project name of the affinity group
projectidthe project ID of the affinity group
typethe type of the affinity group
virtualmachineIdsvirtual machine IDs associated with this affinity group
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
securitygroup(*)list of security groups associated with the virtual machine
idthe ID of the security group
accountthe account owning the security group
descriptionthe description of the security group
domainthe domain name of the security group
domainidthe domain ID of the security group
namethe name of the security group
projectthe project name of the group
projectidthe project id of the group
virtualmachinecountthe number of virtualmachines associated with this securitygroup
virtualmachineidsthe list of virtualmachine ids associated with this securitygroup
egressrule(*)the list of egress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
ingressrule(*)the list of ingress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/cleanVMReservations.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/cleanVMReservations.html b/source/api/apidocs-4.9/apis/cleanVMReservations.html new file mode 100644 index 0000000..2b25eac --- /dev/null +++ b/source/api/apidocs-4.9/apis/cleanVMReservations.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

cleanVMReservations

+

Cleanups VM reservations in the database.

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureF5LoadBalancer.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureF5LoadBalancer.html b/source/api/apidocs-4.9/apis/configureF5LoadBalancer.html new file mode 100644 index 0000000..a796e85 --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureF5LoadBalancer.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureF5LoadBalancer

+

configures a F5 load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidF5 load balancer device IDtrue
lbdevicecapacitycapacity of the device, Capacity will be interpreted as number of networks device can handlefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
ipaddressthe management IP address of the external load balancer
lbdevicecapacitydevice capacity
lbdevicededicatedtrue if device is dedicated for an account
lbdeviceiddevice id of the F5 load balancer
lbdevicenamedevice name
lbdevicestatedevice state
physicalnetworkidthe physical network to which this F5 device belongs to
privateinterfacethe private interface of the load balancer
providername of the provider
publicinterfacethe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureInternalLoadBalancerElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureInternalLoadBalancerElement.html b/source/api/apidocs-4.9/apis/configureInternalLoadBalancerElement.html new file mode 100644 index 0000000..3b4341f --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureInternalLoadBalancerElement.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureInternalLoadBalancerElement

+

Configures an Internal Load Balancer element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the internal lb providertrue
enabledEnables/Disables the Internal Load Balancer elementtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
idthe id of the internal load balancer element
enabledEnabled/Disabled the element
nspidthe physical network service provider id of the element
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureNetscalerLoadBalancer.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureNetscalerLoadBalancer.html b/source/api/apidocs-4.9/apis/configureNetscalerLoadBalancer.html new file mode 100644 index 0000000..ecb884e --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureNetscalerLoadBalancer.html @@ -0,0 +1,136 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureNetscalerLoadBalancer

+

configures a netscaler load balancer device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lbdeviceidNetscaler load balancer device IDtrue
inlinetrue if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewallfalse
lbdevicecapacitycapacity of the device, Capacity will be interpreted as number of networks device can handlefalse
lbdevicededicatedtrue if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accountsfalse
podidsUsed when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
gslbprovidertrue if NetScaler device is provisioned to be a GSLB service provider
gslbproviderprivateipprivate IP of the NetScaler representing GSLB site
gslbproviderpublicippublic IP of the NetScaler representing GSLB site
ipaddressthe management IP address of the external load balancer
isexclusivegslbprovidertrue if NetScaler device is provisioned exclusively to be a GSLB service provider
lbdevicecapacitydevice capacity
lbdevicededicatedtrue if device is dedicated for an account
lbdeviceiddevice id of the netscaler load balancer
lbdevicenamedevice name
lbdevicestatedevice state
physicalnetworkidthe physical network to which this netscaler device belongs to
podidsUsed when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.
privateinterfacethe private interface of the load balancer
providername of the provider
publicinterfacethe public interface of the load balancer
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureOutOfBandManagement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureOutOfBandManagement.html b/source/api/apidocs-4.9/apis/configureOutOfBandManagement.html new file mode 100644 index 0000000..3a5a309 --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureOutOfBandManagement.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureOutOfBandManagement

+

Configures a host's out-of-band management interface

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
addressthe host management interface IP addresstrue
driverthe host management interface driver, for example: ipmitooltrue
hostidthe ID of the hosttrue
passwordthe host management interface passwordtrue
portthe host management interface porttrue
usernamethe host management interface usertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
actionthe out-of-band management action (if issued)
addressthe out-of-band management interface address
descriptionthe operation result description
driverthe out-of-band management driver for the host
enabledtrue if out-of-band management is enabled for the host
hostidthe ID of the host
passwordthe out-of-band management interface password
portthe out-of-band management interface port
powerstatethe out-of-band management interface powerState of the host
statusthe operation result
usernamethe out-of-band management interface username
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureOvsElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureOvsElement.html b/source/api/apidocs-4.9/apis/configureOvsElement.html new file mode 100644 index 0000000..2022f77 --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureOvsElement.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureOvsElement

+

Configures an ovs element.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the ovs providertrue
enabledEnabled/Disabled the service providertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the ovs
accountthe account associated with the provider
domainthe domain associated with the provider
domainidthe domain ID associated with the provider
enabledEnabled/Disabled the service provider
nspidthe physical network service provider id of the provider
projectthe project name of the address
projectidthe project id of the ipaddress
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configurePaloAltoFirewall.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configurePaloAltoFirewall.html b/source/api/apidocs-4.9/apis/configurePaloAltoFirewall.html new file mode 100644 index 0000000..142929a --- /dev/null +++ b/source/api/apidocs-4.9/apis/configurePaloAltoFirewall.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configurePaloAltoFirewall

+

Configures a Palo Alto firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
fwdeviceidPalo Alto firewall device IDtrue
fwdevicecapacitycapacity of the firewall device, Capacity will be interpreted as number of networks device can handlefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
fwdevicecapacitydevice capacity
fwdeviceiddevice id of the Palo Alto firewall
fwdevicenamedevice name
fwdevicestatedevice state
ipaddressthe management IP address of the external firewall
numretriesthe number of times to retry requests to the external firewall
physicalnetworkidthe physical network to which this Palo Alto firewall belongs to
privateinterfacethe private interface of the external firewall
privatezonethe private security zone of the external firewall
providername of the provider
publicinterfacethe public interface of the external firewall
publiczonethe public security zone of the external firewall
timeoutthe timeout (in seconds) for requests to the external firewall
usageinterfacethe usage interface of the external firewall
usernamethe username that's used to log in to the external firewall
zoneidthe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/configureSrxFirewall.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/configureSrxFirewall.html b/source/api/apidocs-4.9/apis/configureSrxFirewall.html new file mode 100644 index 0000000..fe3aac4 --- /dev/null +++ b/source/api/apidocs-4.9/apis/configureSrxFirewall.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

configureSrxFirewall

+

Configures a SRX firewall device

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
fwdeviceidSRX firewall device IDtrue
fwdevicecapacitycapacity of the firewall device, Capacity will be interpreted as number of networks device can handlefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
fwdevicecapacitydevice capacity
fwdeviceiddevice id of the SRX firewall
fwdevicenamedevice name
fwdevicestatedevice state
ipaddressthe management IP address of the external firewall
numretriesthe number of times to retry requests to the external firewall
physicalnetworkidthe physical network to which this SRX firewall belongs to
privateinterfacethe private interface of the external firewall
privatezonethe private security zone of the external firewall
providername of the provider
publicinterfacethe public interface of the external firewall
publiczonethe public security zone of the external firewall
timeoutthe timeout (in seconds) for requests to the external firewall
usageinterfacethe usage interface of the external firewall
usernamethe username that's used to log in to the external firewall
zoneidthe zone ID of the external firewall
+
+
+
+
+
+ +
+
+ +