from BaseClient import BaseClient

class Client(BaseClient):

def createNetworkOffering(self, args={}):

'''

Creates a network offering.

args - A dictionary. The following are options for keys:

displaytext - the display text of the network offering

guestiptype - guest type of the network offering: Shared or Isolated

name - the name of the network offering

supportedservices - services supported by the network offering

traffictype - the traffic type for the network offering. Supported type in

current release is GUEST only

availability - the availability of network offering. Default value is

Optional

conservemode - true if the network offering is IP conserve mode enabled

networkrate - data transfer rate in megabits per second allowed

servicecapabilitylist - desired service capabilities as part of network

offering

serviceofferingid - the service offering ID used by virtual router provider

serviceproviderlist - provider to service mapping. If not specified, the

provider for the service will be mapped to the default provider on the physical

network

specifyipranges - true if network offering supports specifying ip ranges;

defaulted to false if not specified

specifyvlan - true if network offering supports vlans

tags - the tags for the network offering.

'''

if not 'displaytext' in args:

raise RuntimeError("Missing required argument 'displaytext'")

if not 'guestiptype' in args:

raise RuntimeError("Missing required argument 'guestiptype'")

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

if not 'supportedservices' in args:

raise RuntimeError("Missing required argument 'supportedservices'")

if not 'traffictype' in args:

raise RuntimeError("Missing required argument 'traffictype'")

return self.request('createNetworkOffering', args)

def updateNetworkOffering(self, args={}):

'''

Updates a network offering.

args - A dictionary. The following are options for keys:

availability - the availability of network offering. Default value is

Required for Guest Virtual network offering; Optional for Guest Direct network

offering

displaytext - the display text of the network offering

id - the id of the network offering

name - the name of the network offering

sortkey - sort key of the network offering, integer

state - update state for the network offering

'''

return self.request('updateNetworkOffering', args)

def deleteNetworkOffering(self, args={}):

'''

Deletes a network offering.

args - A dictionary. The following are options for keys:

id - the ID of the network offering

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteNetworkOffering', args)

def listNetworkOfferings(self, args={}):

'''

Lists all available network offerings.

args - A dictionary. The following are options for keys:

availability - the availability of network offering. Default value is

Required

displaytext - list network offerings by display text

guestiptype - list network offerings by guest type: Shared or Isolated

id - list network offerings by id

isdefault - true if need to list only default network offerings. Default

value is false

istagged - true if offering has tags specified

keyword - List by keyword

name - list network offerings by name

networkid - the ID of the network. Pass this in if you want to see the

available network offering that a network can be changed to.

page -

pagesize -

sourcenatsupported - true if need to list only netwok offerings where source

nat is supported, false otherwise

specifyipranges - true if need to list only network offerings which support

specifying ip ranges

specifyvlan - the tags for the network offering.

state - list network offerings by state

supportedservices - list network offerings supporting certain services

tags - list network offerings by tags

traffictype - list by traffic type

zoneid - list netowrk offerings available for network creation in specific

zone

page - Pagination

'''

return self.request('listNetworkOfferings', args)

def createNetwork(self, args={}):

'''

Creates a network

args - A dictionary. The following are options for keys:

displaytext - the display text of the network

name - the name of the network

networkofferingid - the network offering id

zoneid - the Zone ID for the network

account - account who will own the network

acltype - Access control type; supported values are account and domain. In

3.0 all shared networks should have aclType=Domain, and all Isolated networks -

Account. Account means that only the account owner can use the network, domain -

all accouns in the domain can use the network

domainid - domain ID of the account owning a network

endip - the ending IP address in the network IP range. If not specified,

will be defaulted to startIP

gateway - the gateway of the network

netmask - the netmask of the network

networkdomain - network domain

physicalnetworkid - the Physical Network ID the network belongs to

projectid - an optional project for the ssh key

startip - the beginning IP address in the network IP range

subdomainaccess - Defines whether to allow subdomains to use networks

dedicated to their parent domain(s). Should be used with aclType=Domain,

defaulted to allow.subdomain.network.access global config if not specified

vlan - the ID or VID of the network

'''

if not 'displaytext' in args:

raise RuntimeError("Missing required argument 'displaytext'")

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

if not 'networkofferingid' in args:

raise RuntimeError("Missing required argument 'networkofferingid'")

if not 'zoneid' in args:

raise RuntimeError("Missing required argument 'zoneid'")

return self.request('createNetwork', args)

def deleteNetwork(self, args={}):

'''

Deletes a network

args - A dictionary. The following are options for keys:

id - the ID of the network

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteNetwork', args)

def listNetworks(self, args={}):

'''

Lists all available networks.

args - A dictionary. The following are options for keys:

account - List resources by account. Must be used with the domainId

parameter.

acltype - list networks by ACL (access control list) type. Supported values

are Account and Domain

domainid - list only resources belonging to the domain specified

id - list networks by id

isrecursive - defaults to false, but if true, lists all resources from the

parent specified by the domainId till leaves.

issystem - true if network is system, false otherwise

keyword - List by keyword

listall - If set to false, list only resources belonging to the command's

caller; if set to true - list resources that the caller is authorized to see.

Default value is false

page -

pagesize -

physicalnetworkid - list networks by physical network id

projectid - list firewall rules by project

restartrequired - list network offerings by restartRequired option

specifyipranges - true if need to list only networks which support

specifying ip ranges

supportedservices - list network offerings supporting certain services

traffictype - type of the traffic

type - the type of the network. Supported values are: Isolated and Shared

zoneid - the Zone ID of the network

page - Pagination

'''

return self.request('listNetworks', args)

def restartNetwork(self, args={}):

'''

Restarts the network; includes 1) restarting network elements - virtual routers,

dhcp servers 2) reapplying all public ips 3) reapplying

loadBalancing/portForwarding rules

args - A dictionary. The following are options for keys:

id - The id of the network to restart.

cleanup - If cleanup old network elements

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('restartNetwork', args)

def updateNetwork(self, args={}):

'''

Updates a network

args - A dictionary. The following are options for keys:

id - the ID of the network

changecidr - Force update even if cidr type is different

displaytext - the new display text for the network

name - the new name for the network

networkdomain - network domain

networkofferingid - network offering ID

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('updateNetwork', args)

def listNetworkACLs(self, args={}):

'''

args - A dictionary. The following are options for keys:

id - Lists network ACL with the specified ID

account - List resources by account. Must be used with the

domainId parameter.

domainid - list only resources belonging to the domain specified

isrecursive - defaults to false, but if true, lists all resources from

the parent specified by the domainId till leaves

keyword - List by keyword

listall - If set to false, list only resources belonging to the command's

caller; if set to true - list resources that the caller is authorized to see.

Default value is false

networkid - list network ACLs by network Id

projectid - list objects by project

tags - List resources by tags (key/value pairs)

traffictype - list network ACLs by traffic type - Ingress or Egress

'''

return self.request('listNetworkACLs', args)

def createPhysicalNetwork(self, args={}):

'''

Creates a physical network

args - A dictionary. The following are options for keys:

name - the name of the physical network

zoneid - the Zone ID for the physical network

broadcastdomainrange - the broadcast domain range for the physical

network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and

Pod in Basic

domainid - domain ID of the account owning a physical network

isolationmethods - the isolation method for the physical

network[VLAN/L3/GRE]

networkspeed - the speed for the physical network[1G/10G]

tags - Tag the physical network

vlan - the VLAN for the physical network

'''

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

if not 'zoneid' in args:

raise RuntimeError("Missing required argument 'zoneid'")

return self.request('createPhysicalNetwork', args)

def deletePhysicalNetwork(self, args={}):

'''

Deletes a Physical Network.

args - A dictionary. The following are options for keys:

id - the ID of the Physical network

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deletePhysicalNetwork', args)

def listPhysicalNetworks(self, args={}):

'''

Lists physical networks

args - A dictionary. The following are options for keys:

id - list physical network by id

keyword - List by keyword

name - search by name

page -

pagesize -

zoneid - the Zone ID for the physical network

page - Pagination

'''

return self.request('listPhysicalNetworks', args)

def updatePhysicalNetwork(self, args={}):

'''

Updates a physical network

args - A dictionary. The following are options for keys:

id - physical network id

networkspeed - the speed for the physical network[1G/10G]

state - Enabled/Disabled

tags - Tag the physical network

vlan - the VLAN for the physical network

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('updatePhysicalNetwork', args)

def listSupportedNetworkServices(self, args={}):

'''

Lists all network services provided by CloudStack or for the given Provider.

args - A dictionary. The following are options for keys:

keyword - List by keyword

page -

pagesize -

provider - network service provider name

service - network service name to list providers and capabilities of

page - Pagination

'''

return self.request('listSupportedNetworkServices', args)

def addNetworkServiceProvider(self, args={}):

'''

Adds a network serviceProvider to a physical network

args - A dictionary. The following are options for keys:

name - the name for the physical network service provider

physicalnetworkid - the Physical Network ID to add the provider to

destinationphysicalnetworkid - the destination Physical Network ID to bridge

to

servicelist - the list of services to be enabled for this physical network

service provider

'''

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

if not 'physicalnetworkid' in args:

raise RuntimeError("Missing required argument 'physicalnetworkid'")

return self.request('addNetworkServiceProvider', args)

def deleteNetworkServiceProvider(self, args={}):

'''

Deletes a Network Service Provider.

args - A dictionary. The following are options for keys:

id - the ID of the network service provider

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteNetworkServiceProvider', args)

def listNetworkServiceProviders(self, args={}):

'''

Lists network serviceproviders for a given physical network.

args - A dictionary. The following are options for keys:

keyword - List by keyword

name - list providers by name

page -

pagesize -

physicalnetworkid - the Physical Network ID

state - list providers by state

page - Pagination

'''

return self.request('listNetworkServiceProviders', args)

def updateNetworkServiceProvider(self, args={}):

'''

Updates a network serviceProvider of a physical network

args - A dictionary. The following are options for keys:

id - network service provider id

servicelist - the list of services to be enabled for this physical network

service provider

state - Enabled/Disabled/Shutdown the physical network service provider

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('updateNetworkServiceProvider', args)

def createStorageNetworkIpRange(self, args={}):

'''

Creates a Storage network IP range.

args - A dictionary. The following are options for keys:

gateway - the gateway for storage network

netmask - the netmask for storage network

podid - UUID of pod where the ip range belongs to

startip - the beginning IP address

endip - the ending IP address

vlan - Optional. The vlan the ip range sits on, default to Null when it is

not specificed which means you network is not on any Vlan. This is mainly for

Vmware as other hypervisors can directly reterive bridge from pyhsical network

traffic type table

'''

if not 'gateway' in args:

raise RuntimeError("Missing required argument 'gateway'")

if not 'netmask' in args:

raise RuntimeError("Missing required argument 'netmask'")

if not 'podid' in args:

raise RuntimeError("Missing required argument 'podid'")

if not 'startip' in args:

raise RuntimeError("Missing required argument 'startip'")

return self.request('createStorageNetworkIpRange', args)

def deleteStorageNetworkIpRange(self, args={}):

'''

Deletes a storage network IP Range.

args - A dictionary. The following are options for keys:

id - the uuid of the storage network ip range

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteStorageNetworkIpRange', args)

def listStorageNetworkIpRange(self, args={}):

'''

List a storage network IP range.

args - A dictionary. The following are options for keys:

id - optional parameter. Storaget network IP range uuid, if specicied, using

it to search the range.

keyword - List by keyword

page -

pagesize -

podid - optional parameter. Pod uuid, if specicied and range uuid is absent,

using it to search the range.

zoneid - optional parameter. Zone uuid, if specicied and both pod uuid and

range uuid are absent, using it to search the range.

page - Pagination

'''

return self.request('listStorageNetworkIpRange', args)

def updateStorageNetworkIpRange(self, args={}):

'''

Update a Storage network IP range, only allowed when no IPs in this range have

been allocated.

args - A dictionary. The following are options for keys:

id - UUID of storage network ip range

endip - the ending IP address

netmask - the netmask for storage network

startip - the beginning IP address

vlan - Optional. the vlan the ip range sits on

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('updateStorageNetworkIpRange', args)

def addNetworkDevice(self, args={}):

'''

Adds a network device of one of the following types: ExternalDhcp,

ExternalFirewall, ExternalLoadBalancer, PxeServer

args - A dictionary. The following are options for keys:

networkdeviceparameterlist - parameters for network device

networkdevicetype - Network device type, now supports ExternalDhcp,

PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer,

NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall

'''

return self.request('addNetworkDevice', args)

def listNetworkDevice(self, args={}):

'''

List network devices

args - A dictionary. The following are options for keys:

keyword - List by keyword

networkdeviceparameterlist - parameters for network device

networkdevicetype - Network device type, now supports ExternalDhcp,

PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer,

NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall

page -

pagesize -

page - Pagination

'''

return self.request('listNetworkDevice', args)

def deleteNetworkDevice(self, args={}):

'''

Deletes network device.

args - A dictionary. The following are options for keys:

id - Id of network device to delete

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteNetworkDevice', args)

def listF5LoadBalancerNetworks(self, args={}):

'''

lists network that are using a F5 load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - f5 load balancer device ID

keyword - List by keyword

page -

pagesize -

page - Pagination

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('listF5LoadBalancerNetworks', args)

def listSrxFirewallNetworks(self, args={}):

'''

lists network that are using SRX firewall device

args - A dictionary. The following are options for keys:

lbdeviceid - netscaler load balancer device ID

keyword - List by keyword

page -

pagesize -

page - Pagination

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('listSrxFirewallNetworks', args)

def listNetscalerLoadBalancerNetworks(self, args={}):

'''

lists network that are using a netscaler load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - netscaler load balancer device ID

keyword - List by keyword

page -

pagesize -

page - Pagination

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('listNetscalerLoadBalancerNetworks', args)

def createLoadBalancerRule(self, args={}):

'''

Creates a load balancer rule

args - A dictionary. The following are options for keys:

algorithm - load balancer algorithm (source, roundrobin, leastconn)

name - name of the load balancer rule

privateport - the private port of the private ip address/virtual machine

where the network traffic will be load balanced to

publicport - the public port from where the network traffic will be load

balanced from

account - the account associated with the load balancer. Must be used with

the domainId parameter.

cidrlist - the cidr list to forward traffic from

description - the description of the load balancer rule

domainid - the domain ID associated with the load balancer

networkid - The guest network this rule will be created for

openfirewall - if true, firewall rule for source/end pubic port is

automatically created; if false - firewall rule has to be created explicitely.

Has value true by default

publicipid - public ip address id from where the network traffic will be

load balanced from

zoneid - zone where the load balancer is going to be created. This parameter

is required when LB service provider is ElasticLoadBalancerVm

'''

if not 'algorithm' in args:

raise RuntimeError("Missing required argument 'algorithm'")

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

if not 'privateport' in args:

raise RuntimeError("Missing required argument 'privateport'")

if not 'publicport' in args:

raise RuntimeError("Missing required argument 'publicport'")

return self.request('createLoadBalancerRule', args)

def deleteLoadBalancerRule(self, args={}):

'''

Deletes a load balancer rule.

args - A dictionary. The following are options for keys:

id - the ID of the load balancer rule

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteLoadBalancerRule', args)

def removeFromLoadBalancerRule(self, args={}):

'''

Removes a virtual machine or a list of virtual machines from a load balancer

rule.

args - A dictionary. The following are options for keys:

id - The ID of the load balancer rule

virtualmachineids - the list of IDs of the virtual machines that are being

removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

if not 'virtualmachineids' in args:

raise RuntimeError("Missing required argument 'virtualmachineids'")

return self.request('removeFromLoadBalancerRule', args)

def assignToLoadBalancerRule(self, args={}):

'''

Assigns virtual machine or a list of virtual machines to a load balancer rule.

args - A dictionary. The following are options for keys:

id - the ID of the load balancer rule

virtualmachineids - the list of IDs of the virtual machine that are being

assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

if not 'virtualmachineids' in args:

raise RuntimeError("Missing required argument 'virtualmachineids'")

return self.request('assignToLoadBalancerRule', args)

def createLBStickinessPolicy(self, args={}):

'''

Creates a Load Balancer stickiness policy

args - A dictionary. The following are options for keys:

lbruleid - the ID of the load balancer rule

methodname - name of the LB Stickiness policy method, possible values can be

obtained from ListNetworks API

name - name of the LB Stickiness policy

description - the description of the LB Stickiness policy

param - param list. Example:

param[0].name=cookiename&param[0].value=LBCookie

'''

if not 'lbruleid' in args:

raise RuntimeError("Missing required argument 'lbruleid'")

if not 'methodname' in args:

raise RuntimeError("Missing required argument 'methodname'")

if not 'name' in args:

raise RuntimeError("Missing required argument 'name'")

return self.request('createLBStickinessPolicy', args)

def deleteLBStickinessPolicy(self, args={}):

'''

Deletes a LB stickiness policy.

args - A dictionary. The following are options for keys:

id - the ID of the LB stickiness policy

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('deleteLBStickinessPolicy', args)

def listLoadBalancerRules(self, args={}):

'''

Lists load balancer rules.

args - A dictionary. The following are options for keys:

account - List resources by account. Must be used with the domainId

parameter.

domainid - list only resources belonging to the domain specified

id - the ID of the load balancer rule

isrecursive - defaults to false, but if true, lists all resources from the

parent specified by the domainId till leaves.

keyword - List by keyword

listall - If set to false, list only resources belonging to the command's

caller; if set to true - list resources that the caller is authorized to see.

Default value is false

name - the name of the load balancer rule

page -

pagesize -

projectid - list firewall rules by project

publicipid - the public IP address id of the load balancer rule

virtualmachineid - the ID of the virtual machine of the load balancer rule

zoneid - the availability zone ID

page - Pagination

'''

return self.request('listLoadBalancerRules', args)

def listLBStickinessPolicies(self, args={}):

'''

Lists LBStickiness policies.

args - A dictionary. The following are options for keys:

lbruleid - the ID of the load balancer rule

keyword - List by keyword

page -

pagesize -

page - Pagination

'''

if not 'lbruleid' in args:

raise RuntimeError("Missing required argument 'lbruleid'")

return self.request('listLBStickinessPolicies', args)

def listLoadBalancerRuleInstances(self, args={}):

'''

List all virtual machine instances that are assigned to a load balancer rule.

args - A dictionary. The following are options for keys:

id - the ID of the load balancer rule

applied - true if listing all virtual machines currently applied to the load

balancer rule; default is true

keyword - List by keyword

page -

pagesize -

page - Pagination

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('listLoadBalancerRuleInstances', args)

def updateLoadBalancerRule(self, args={}):

'''

Updates load balancer

args - A dictionary. The following are options for keys:

id - the id of the load balancer rule to update

algorithm - load balancer algorithm (source, roundrobin, leastconn)

description - the description of the load balancer rule

name - the name of the load balancer rule

'''

if not 'id' in args:

raise RuntimeError("Missing required argument 'id'")

return self.request('updateLoadBalancerRule', args)

def addF5LoadBalancer(self, args={}):

'''

Adds a F5 BigIP load balancer device

args - A dictionary. The following are options for keys:

networkdevicetype - supports only F5BigIpLoadBalancer

password - Credentials to reach F5 BigIP load balancer device

physicalnetworkid - the Physical Network ID

url - URL of the F5 load balancer appliance.

username - Credentials to reach F5 BigIP load balancer device

'''

if not 'networkdevicetype' in args:

raise RuntimeError("Missing required argument 'networkdevicetype'")

if not 'password' in args:

raise RuntimeError("Missing required argument 'password'")

if not 'physicalnetworkid' in args:

raise RuntimeError("Missing required argument 'physicalnetworkid'")

if not 'url' in args:

raise RuntimeError("Missing required argument 'url'")

if not 'username' in args:

raise RuntimeError("Missing required argument 'username'")

return self.request('addF5LoadBalancer', args)

def configureF5LoadBalancer(self, args={}):

'''

configures a F5 load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - F5 load balancer device ID

lbdevicecapacity - capacity of the device, Capacity will be interpreted as

number of networks device can handle

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('configureF5LoadBalancer', args)

def deleteF5LoadBalancer(self, args={}):

'''

delete a F5 load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - netscaler load balancer device ID

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('deleteF5LoadBalancer', args)

def listF5LoadBalancers(self, args={}):

'''

lists F5 load balancer devices

args - A dictionary. The following are options for keys:

keyword - List by keyword

lbdeviceid - f5 load balancer device ID

page -

pagesize -

physicalnetworkid - the Physical Network ID

page - Pagination

'''

return self.request('listF5LoadBalancers', args)

def addNetscalerLoadBalancer(self, args={}):

'''

Adds a netscaler load balancer device

args - A dictionary. The following are options for keys:

networkdevicetype - Netscaler device type supports NetscalerMPXLoadBalancer,

NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer

password - Credentials to reach netscaler load balancer device

physicalnetworkid - the Physical Network ID

url - URL of the netscaler load balancer appliance.

username - Credentials to reach netscaler load balancer device

'''

if not 'networkdevicetype' in args:

raise RuntimeError("Missing required argument 'networkdevicetype'")

if not 'password' in args:

raise RuntimeError("Missing required argument 'password'")

if not 'physicalnetworkid' in args:

raise RuntimeError("Missing required argument 'physicalnetworkid'")

if not 'url' in args:

raise RuntimeError("Missing required argument 'url'")

if not 'username' in args:

raise RuntimeError("Missing required argument 'username'")

return self.request('addNetscalerLoadBalancer', args)

def deleteNetscalerLoadBalancer(self, args={}):

'''

delete a netscaler load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - netscaler load balancer device ID

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('deleteNetscalerLoadBalancer', args)

def configureNetscalerLoadBalancer(self, args={}):

'''

configures a netscaler load balancer device

args - A dictionary. The following are options for keys:

lbdeviceid - Netscaler load balancer device ID

inline - true if netscaler load balancer is intended to be used in in-line

with firewall, false if netscaler load balancer will side-by-side with firewall

lbdevicecapacity - capacity of the device, Capacity will be interpreted as

number of networks device can handle

lbdevicededicated - true if this netscaler device to dedicated for a

account, false if the netscaler device will be shared by multiple accounts

'''

if not 'lbdeviceid' in args:

raise RuntimeError("Missing required argument 'lbdeviceid'")

return self.request('configureNetscalerLoadBalancer', args)

def listNetscalerLoadBalancers(self, args={}):

'''

lists netscaler load balancer devices

args - A dictionary. The following are options for keys:

keyword - List by keyword

lbdeviceid - netscaler load balancer device ID

page -

pagesize -

physicalnetworkid - the Physical Network ID

page - Pagination

'''

return self.request('listNetscalerLoadBalancers', args)

def listVPCs(self,args={}):

'''

lists Virtual Private Clouds (VPCs) configured

args - A dictionary. The following are options for keys:

account - list by account associated with the VPC. Must be used

with the domainId parameter.

account - List resources by account. Must be used with the domainId parameter.

cidr - list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR

displaytext - List by display text of the VPC

domainid - list by domain ID associated with the VPC. If used with the account

parameter returns the VPC associated with the account for the specified domain.

domainid - list only resources belonging to the domain specified

id - list VPC by id false

isrecursive - defaults to false, but if true, lists all resources from the parent

specified by the domainId till leaves.

keyword - List by keyword

listall - If set to false, list only resources belonging to the command's caller;

if set to true - list resources that the caller is authorized to see. Default

value is false

name - list by name of the VPC

page -

pagesize -

projectid - list objects by project

restartrequired - list VPCs by restartRequired option

state - list VPCs by state

supportedservices - list VPC supporting certain services

tags - List resources by tags (key/value pairs)

vpcofferingid - list by ID of the VPC offering

zoneid - list by zone

'''

return self.request('listVPCs',args)

def deployVirtualMachine(self, args={}):

'''

Creates and automatically starts a virtual machine based on a service offering,

disk offering, and template.

args - A dictionary. The following are options for keys:

serviceofferingid - the ID of the service offering for the virtual machine

templateid - the ID of the template for the virtual machine

zoneid - availability zone for the virtual machine

account - an optional account for the virtual machine. Must be used with

domainId.

diskofferingid - the ID of the disk offering for the virtual machine. If the

template is of ISO format, the diskOfferingId is for the root disk volume.

Otherwise this parameter is used to indicate the offering for the data disk

volume. If the templateId parameter passed is from a Template object, the

diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter

passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume

created.

displayname - an optional user generated name for the virtual machine

domainid - an optional domainId for the virtual machine. If the account

parameter is used, domainId must also be used.

group - an optional group for the virtual machine

hostid - destination Host ID to deploy the VM to - parameter available for

root admin only

hypervisor - the hypervisor on which to deploy the virtual machine

ipaddress - the ip address for default vm's network

iptonetworklist - ip to network mapping. Can't be specified with networkIds

parameter. Example:

iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].networkid=204 - requests to

use ip 10.10.10.11 in network id=204

keyboard - an optional keyboard device type for the virtual machine. valid

value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us

keypair - name of the ssh key pair used to login to the virtual machine

name - host name for the virtual machine

networkids - list of network ids used by virtual machine. Can't be specified

with ipToNetworkList parameter

projectid - Deploy vm for the project

securitygroupids - comma separated list of security groups id that going to

be applied to the virtual machine. Should be passed only when vm is created from

a zone with Basic Network support. Mutually exclusive with securitygroupnames

parameter