didata_cloud_sdk 0.3.1

data/doc/pagination-and-filtering.txt

@@ -0,0 +1,24 @@
+Request
+-------
+'pageSize=50'
+'pageNumber=3' If the value supplied exceeds the number of pages for the request, the last page will be returned.
+'orderBy=location,created.DESCENDING' Means “sort first by location ascending, then by created descending”.
+
+Response
+--------
+totalCount
+pageCount
+pageNumber
+pageSize
+
+Filtering
+---------
+<fieldName>[.comparativeOperator]=<value>
+'&location=NA1' location equals NA1
+'&location=NA1&location=NA2' location “NA1” or in location “NA2”.
+
+
+client.page_size = 10
+client.page_number = 1
+client.order_by = 'location,created.DESCENDING'
+client.filter = {location: %w(NA1 NA2)}

data/doc/schemas.txt

@@ -0,0 +1,10 @@
+/schemas/datacenter
+/schemas/directory
+/schemas/general
+/schemas/multigeo
+/schemas/network
+/schemas/organization
+/schemas/server
+/schemas/storage
+/schemas/vip
+/schemas/vips

data/doc/sections.txt

@@ -0,0 +1,101 @@
+2.1.     Get My Account Details
+2.2.     Add Sub-Administrator Account
+2.3.     Update Administrator Account
+2.4.     Delete Sub-Administrator Account
+2.5.     List Accounts
+2.6.     List Data Centers With Parameters
+2.7.     List Multi-Geography Data Centers With Key
+2.8.     List Software Labels
+3.1.     List OS Server Images
+3.2.     List OS Server Images with Software Labels in Location
+3.3.     List Deployed Customer Images
+3.4.     List Deployed Customer Images with Software Labels in Location
+3.5.     List Pending Deployment Customer Images
+3.6.     List Pending Deployment Customer Images in Location
+3.7.     Does Image Name Exist?
+3.8.     Get Server Image
+3.9.     Delete Customer Server Image
+3.10.    Modify Customer Server Image
+3.11.    Clean Failed Customer Image
+4.1.     List OVF Packages
+4.2.     Import Customer Image
+4.3.     List Customer Image Imports in Progress
+4.4.     Export Customer Image
+4.5.     List Customer Image Exports in Progress
+4.6.     List Customer Image Export History
+4.7.     Copy Customer Image to Data Center
+4.8.     List Customer Image Copying in Progress
+4.9.     Copy OVF Package from Remote Geo
+4.10.    List Remote OVF Package Copying in Progress
+4.11.    List Remote OVF Package Copy History
+5.1.     List Servers (With Parameters)
+5.2.     Clean Failed Server Deployment
+5.3.     Deploy Server
+5.4.     Delete Server
+5.5.     Modify Server
+5.6.     Start Server
+5.7.     Shutdown Server (Graceful Stop)
+5.8.     Power Off Server
+5.9.     Reboot Server
+5.10.    Reset Server
+5.11.    Update VMware Tools
+5.12.    Add Storage to Server
+5.13.    Remove Storage from Server
+5.14.    Change Server Disk Speed
+5.15.    Clone Server to Create Customer Image
+5.16.    Create Server Anti-Affinity Rule
+5.17.    List Server Anti-Affinity Rules
+5.18.    Delete Server Anti-Affinity Rule
+6.1.     List Networks
+6.2.     List Networks with Location
+6.3.     List Networks in Location
+6.4.     Get Network Details
+6.5.     Create Network
+6.6.     Create Network with Location
+6.7.     Delete Network
+6.8.     Modify Network
+6.9.     List Deployed Servers on Network with Disks
+6.10.    List Pending Deployment Servers on Network with Disks
+6.11.    List ACL Rules
+6.12.    Create ACL Rule
+6.13.    List NAT Rules
+6.14.    Create NAT rule
+6.15.    Delete NAT rule
+6.16.    Get Network Configuration
+6.17.    Get Network Configuration with Location
+6.18.    Reserve Public IP Block with Size
+6.19.    Release Public IP Block
+6.20.    Set Server to VIP connectivity for Public IP Block
+6.21.    Multicast
+7.1.     List Real Servers
+7.2.     Create Real Server
+7.3.     Delete Real Server
+7.4.     Modify Real Server
+7.5.     List Probes
+7.6.     Create Probe
+7.7.     Modify Probe
+7.8.     Delete Probe
+7.9.     List Server Farms
+7.10.    Get Server Farm Details
+7.11.    Create Server Farm
+7.12.    Delete Server Farm
+7.13.    Add Real Server to Server Farm
+7.14.    Remove Real Server from Server Farm
+7.15.    Add Probe to Server Farm
+7.16.    Remove Probe from Server Farm
+7.17.    Modify Server Farm Predictor
+7.18.    List Persistence Profiles
+7.19.    Create Persistence Profile
+7.20.    Delete Persistence Profile
+7.21.    List VIPs
+7.22.    Create VIP
+7.23.    Delete VIP
+7.24.    Modify VIP
+8.1.     Create Files Account
+8.2.     List Files Accounts
+8.3.     Delete Files Account
+8.4.     Modify Files Account
+9.1.     Summary Usage Report
+9.2.     Detailed Usage Report
+9.3.     Software Units Report
+9.4.     Audit Log Report

data/doc/urls.txt

@@ -0,0 +1,101 @@
+/base/image
+/base/image/deployedWithSoftwareLabels/{location-id}
+/base/image/{location-id}
+/image-provider/image/db
+/image-provider/image/web
+/myaccount
+/partner/image
+/{org-id}/
+/{org-id}/account
+/{org-id}/account/{userName}
+/{org-id}/account/{username}?delete
+/{org-id}/antiAffinityRule
+/{org-id}/antiAffinityRule/{ruleid}?delete
+/{org-id}/antiAffinityRule?
+/{org-id}/auditlog?startDate=YYYYMM-DD&endDate=YYYY-MM-DD
+/{org-id}/copyCustomerImage
+/{org-id}/datacenter
+/{org-id}/datacenterWithDiskSpeed?
+/{org-id}/datacenterWithLimits
+/{org-id}/geo
+/{org-id}/image List Customer Server Images [DEPRECATED]
+/{org-id}/image/deployed
+/{org-id}/image/deployed/{locationid}
+/{org-id}/image/deployedWithSoftwareLabels/{location-id}
+/{org-id}/image/nameExists
+/{org-id}/image/pendingDeploy
+/{org-id}/image/pendingDeploy/{location-id}
+/{org-id}/image/{image-id}
+/{org-id}/image/{image-id}?clean
+/{org-id}/image/{image-id}?delete
+/{org-id}/imageExport
+/{org-id}/imageExportHistory?count=n
+/{org-id}/imageImport
+/{org-id}/multigeo
+/{org-id}/network
+/{org-id}/network/{net-id}
+/{org-id}/network/{net-id}/aclrule
+/{org-id}/network/{net-id}/natrule
+/{org-id}/network/{netid}/aclrule/{acl-id}?delete
+/{org-id}/network/{netid}/publicip?reserveNew
+/{org-id}/network/{network-id}
+/{org-id}/network/{network-id}/vip
+/{org-id}/network/{networkid}/aclrule
+/{org-id}/network/{networkid}/config
+/{org-id}/network/{networkid}/natrule/{natrule-id}?delete
+/{org-id}/network/{networkid}/persistenceProfile
+/{org-id}/network/{networkid}/persistenceProfile/{persistence-profile-id}?delete
+/{org-id}/network/{networkid}/probe
+/{org-id}/network/{networkid}/probe/{probe-id}
+/{org-id}/network/{networkid}/probe/{probe-id}?delete
+/{org-id}/network/{networkid}/publicip/{ipblock-id}
+/{org-id}/network/{networkid}/publicip/{ipblock-id}?release
+/{org-id}/network/{networkid}/publicip?reserveNewWithSize
+/{org-id}/network/{networkid}/realServer
+/{org-id}/network/{networkid}/realServer/{rserver-id}
+/{org-id}/network/{networkid}/realServer/{rserver-id}?delete
+/{org-id}/network/{networkid}/server
+/{org-id}/network/{networkid}/server/deployed
+/{org-id}/network/{networkid}/server/deployedWithDisks
+/{org-id}/network/{networkid}/server/deployedWithSoftwareLabels
+/{org-id}/network/{networkid}/server/deployedWithStatus
+/{org-id}/network/{networkid}/server/pendingDeploy
+/{org-id}/network/{networkid}/server/pendingDeployWithDisks
+/{org-id}/network/{networkid}/serverFarm
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}/addProbe
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}/addRealServer
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}/removeProbe
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}/removeRealServer
+/{org-id}/network/{networkid}/serverFarm/{server-farm-id}?delete
+/{org-id}/network/{networkid}/vip/{vip-id}
+/{org-id}/network/{networkid}/vip/{vip-id}?delete
+/{org-id}/network/{networkid}?delete
+/{org-id}/networkWithLocation
+/{org-id}/networkWithLocation/{locationid}
+/{org-id}/networkWithLocation/{networkid}/config
+/{org-id}/ovfPackage
+/{org-id}/remoteOvfPackageCopy
+/{org-id}/remoteOvfPackageCopyHistory?
+/{org-id}/server
+/{org-id}/server/deployed
+/{org-id}/server/pendingDeploy
+/{org-id}/server/{server-id}
+/{org-id}/server/{server-id}?clean
+/{org-id}/server/{server-id}?delete
+/{org-id}/server/{server-id}?reboot
+/{org-id}/server/{server-id}?reset
+/{org-id}/server/{server-id}?start
+/{org-id}/server/{server-id}?stop
+/{org-id}/server/{serverid}/disk/{disk-id}/changeSpeed
+/{org-id}/server/{serverid}/disk/{disk-id}?delete
+/{org-id}/server/{serverid}?addLocalStorage&amount=10
+/{org-id}/server/{serverid}?poweroff
+/{org-id}/server/{serverid}?restart
+/{org-id}/server/{serverid}?shutdown
+/{org-id}/server/{serverid}?updateVMwareTools
+/{org-id}/serverWithState
+/{org-id}/softwarelabel
+/{org-id}/storageAccount
+/{org-id}/storageAccount/<filesaccount-username>
+/{org-id}/storageAccount/<filesaccount-username>?delete

data/lib/opsource/api/account.rb

@@ -0,0 +1,13 @@
+module Opsource::API
+  class Account < Core
+    def myaccount()
+      endpoint "/myaccount"
+      get
+    end
+
+    def list()
+      org_endpoint "/account"
+      get
+    end
+  end
+end

data/lib/opsource/api/core.rb

@@ -0,0 +1,127 @@
+module Opsource::API
+  class Core
+    attr_reader :client
+    def initialize(client)
+      @client = client
+    end
+
+
+    ### client methods
+
+    def log(*args)
+      @client.log(*args)
+    end
+
+    def org_id
+      @client.org_id
+    end
+
+
+    ### request options
+
+    def endpoint(e)
+      @endpoint = e
+    end
+
+    def org_endpoint(e)
+      endpoint("/#{org_id}" + e)
+    end
+
+    def query_params(q)
+      @query_params = q
+    end
+
+    def xml_params(x)
+      @xml_params = x
+    end
+
+    def simple_params(x)
+      @simple_params = x
+    end
+
+    ### perform request
+
+    def get
+      perform :get
+    end
+
+    def post
+      perform :post
+    end
+
+    def get_simple
+        perform :get, true
+    end
+
+    def post_simple
+        perform :post, true
+    end
+
+    #do not parse response if simple
+    #if simple, post body is also simple...
+    def perform(method, simple=false)
+      if simple
+        request = @client.build_request(method, @endpoint, request_query_string, request_simple_body, false)
+      else
+        request = @client.build_request(method, @endpoint, request_query_string, request_xml_body)
+      end
+      response = @client.perform_request(request)
+
+      @client.log_response(request, response)
+
+      # return parsed object if it's good
+      if response.success?
+        if simple
+          result = response.body
+        else
+          result = @client.parse_response_xml_body(response.body)
+          if result['total_count']
+            log "#{result['total_count']} total", :yellow, :bold
+            result.delete('page_size')
+            result.delete('total_count')
+            result.delete('page_count')
+            result.delete('page_number')
+          end
+          # unwind some arrays of elements
+          result.values.count == 1 ? result.values.first : result
+        end
+      else
+        {}
+      end
+    end
+
+    def single(results)
+      if results.is_a? Array
+        results.first
+      else
+        results
+      end
+    end
+
+
+    ### build request
+
+    def request_query_string
+      fparams = @client.filter_params || {}
+      qparams = @query_params || {}
+      params = fparams.merge(qparams)
+      @client.url_query(params) if params.present?
+    end
+
+    def request_xml_body
+      return if @xml_params.blank?
+      schema = @xml_params.delete(:schema)
+      tag = @xml_params.delete(:tag)
+
+      body = @client.build_request_xml_body(schema, tag, @xml_params)
+      log(body, :green)
+      body
+    end
+    def request_simple_body
+      return if @simple_params.blank?
+      body = @client.build_request_simple_body(@simple_params)
+      log(body, :green)
+      body
+    end
+  end
+end

data/lib/opsource/api/directory.rb

@@ -0,0 +1,8 @@
+module Opsource::API
+  class Directory < Core
+    def data_center_list
+      org_endpoint "/datacenterWithDiskSpeed"
+      get
+    end
+  end
+end

data/lib/opsource/api/image.rb

@@ -0,0 +1,24 @@
+module Opsource::API
+  class Image < Core
+    def server_list
+      endpoint '/base/image'
+      get
+    end
+
+    def deployed_list(options = {})
+      endpoint "/#{org_id}/image/deployed"
+      query_params options
+      get
+    end
+
+    def show_by_name(name, options = {})
+      options[:name] = name
+      single(deployed_list(options))
+    end
+
+    def show(image_id)
+      endpoint "/#{org_id}/image/#{image_id}"
+      get
+    end
+  end
+end

data/lib/opsource/api/network.rb

@@ -0,0 +1,65 @@
+module Opsource::API
+  class Network < Core
+    def list
+      org_endpoint '/network'
+      get
+    end
+
+    def create(name, description="", datacenter=@client.datacenter)
+      org_endpoint "/networkWithLocation"
+      xml_params(schema: "network", tag: "NewNetworkWithLocation", name: name, description: description, location: datacenter)
+      post
+    end
+
+    def list_with_location
+      org_endpoint "/networkWithLocation"
+      get
+    end
+
+    def list_in_location(location_id)
+      org_endpoint "/networkWithLocation/#{location_id}"
+      get
+    end
+
+    def show(network_id)
+      list_with_location.find {|n| n.id == network_id}
+    end
+
+    def show_by_name(name)
+     list_with_location.find {|n| n.name == name}
+    end
+
+    def natrule_list(network_id)
+      org_endpoint "/network/#{network_id}/natrule"
+      get
+    end
+
+    # name = "10.147.15.11", source_ip = "10.147.15.11"
+    def natrule_create(network_id, name, source_ip)
+      org_endpoint "/network/#{network_id}/natrule"
+      xml_params(schema: "network", tag: "NatRule", name: name, source_ip: source_ip)
+      post
+    end
+
+    def natrule_delete(network_id, natrule_id)
+      org_endpoint "/network/#{network_id}/natrule/#{natrule_id}?delete"
+      get
+    end
+
+    def aclrule_list(network_id)
+      org_endpoint "/network/#{network_id}/aclrule"
+      get
+    end
+
+    def aclrule_delete(network_id, aclrule_id)
+      org_endpoint "/network/#{network_id}/aclrule/#{aclrule_id}?delete"
+      get
+    end
+
+    def aclrule_create(network_id, name, position, inbound, protocol, port, allow)
+      org_endpoint "/network/#{network_id}/aclrule"
+      xml_params(schema: "network", tag: "AclRule", name: name, position: position, action: (allow ? "PERMIT" : "DENY"), protocol: protocol, source_ip_range: {}, destination_ip_range: {}, port_range: {type: "EQUAL_TO", port1: port}, type: (inbound ? "OUTSIDE_ACL" : "INSIDE_ACL"))
+      post
+    end
+  end
+end

data/lib/opsource/api/report.rb

@@ -0,0 +1,24 @@
+module Opsource::API
+    class Report < Core
+        def auditlog(start_date, end_date)
+            start = start_date.strftime("%Y-%m-%d")
+            stop = end_date.strftime("%Y-%m-%d")
+            org_endpoint "/auditlog?startDate=#{start}&endDate=#{stop}"
+            get_simple
+        end
+
+        def summary_usage(start_date, end_date)
+            start = start_date.strftime("%Y-%m-%d")
+            stop = end_date.strftime("%Y-%m-%d")
+            org_endpoint "/report/usage?startDate=#{start}&endDate=#{stop}"
+            get_simple
+        end
+
+        def detailed_usage(start_date, end_date)
+            start = start_date.strftime("%Y-%m-%d")
+            stop = end_date.strftime("%Y-%m-%d")
+            org_endpoint "/report/usageDetailed?startDate=#{start}&endDate=#{stop}"
+            get_simple
+        end
+    end
+end

data/lib/opsource/api/server.rb

@@ -0,0 +1,185 @@
+module Opsource::API
+  class Server < Core
+
+    # id
+    # location
+    # networkId
+    # sourceImageId
+    # deployed boolean
+    # name -- Matched against names of servers
+    # created.MIN=20120901T00:00:00Z
+    # created.MAX=20120901T00:00:00Z
+    # state
+    #   "NORMAL",
+    #   "PENDING_ADD",
+    #   "PENDING_CHANGE",
+    #   "PENDING_DELETE",
+    #   "FAILED_ADD",
+    #   "FAILED_DELETE",
+    #   "PENDING_CLEAN" and
+    #   "REQUIRES_SUPPORT".
+    # order_by: started, operatingSystemId, state and all other
+    def list(options = {})
+      org_endpoint "/serverWithState"
+      query_params options
+      get
+    end
+
+    def list_deployed_with_disks(network_id, options = {})
+      org_endpoint "/network/#{network_id}/server/deployedWithDisks"
+      query_params options
+      get
+    end
+
+    def show(server_id, options = {})
+      options[:id] = server_id
+      single(list(options))
+    end
+
+    def show_by_name(name, options = {})
+      options[:name] = name
+      single(list(options))
+    end
+
+    def show_by_ip(ip, options = {})
+      options[:private_ip] = ip
+      single(list(options))
+    end
+
+    def show_with_disks(network_id, server_id, options = {})
+      list_deployed_with_disks(network_id, options).find {|s| s.id == server_id}
+    end
+
+    def create(name, description, network_id, image_id, administrator_password=@client.default_password)
+      org_endpoint "/server"
+      xml_params(
+        tag: "Server",
+        schema: "server",
+        name: name,
+        description: description,
+        vlan_resource_path: "/oec/#{org_id}/network/#{network_id}",
+        image_resource_path: "/oec/base/image/#{image_id}",
+        is_started: 'true',
+        administrator_password: administrator_password
+      )
+      post
+    end
+
+    def delete(server_id)
+      org_endpoint "/server/#{server_id}?delete"
+      get
+    end
+
+    # memory in MB, ust be multiple of 1024
+    def modify(server_id, name = nil, description = nil, cpu_count = nil, memory = nil)
+      query_params(
+        name: name,
+        description: description,
+        cpu_count: cpu_count,
+        memory: memory
+      )
+      org_endpoint "/server/#{server_id}"
+      post
+    end
+
+    def start(server_id)
+      org_endpoint "/server/#{server_id}?start"
+      get
+    end
+
+    def shutdown(server_id)
+      org_endpoint "/server/#{server_id}?shutdown"
+      get
+    end
+
+    def poweroff(server_id)
+      org_endpoint "/server/#{server_id}?poweroff"
+      get
+    end
+
+    def reboot(server_id)
+      org_endpoint "/server/#{server_id}?reboot"
+      get
+    end
+
+    def reset(server_id)
+      org_endpoint "/server/#{server_id}?reset"
+      get
+    end
+
+    # amount is # of GBs
+    def add_storage(server_id, amount)
+      org_endpoint "/server/#{server_id}?addLocalStorage"
+      query_params(amount: amount)
+      get
+    end
+
+    def remove_storage(server_id, disk_id)
+      org_endpoint "/server/#{server_id}/disk/#{disk_id}?delete"
+      get
+    end
+
+  end
+end
+
+#### ServersWithState
+# <ServersWithState
+# xmlns="http://oec.api.opsource.net/schemas/server"
+# totalCount="320"
+# pageCount="250"
+# pageNumber="1"
+# pageSize="250">
+# <!--Zero or more repetitions:-->
+# <serverWithState id="c325fe04-7711-4968-962e-c88784eb2" location="NA1">
+# <name>Production LAMP Server</name>
+# <!--Optional:-->
+# <description>Main web application server.</description>
+# <operatingSystem id="REDHAT564" displayName="REDHAT5/64" type="UNIX"/>
+# <cpuCount>2</cpuCount>
+# <memoryMb>4096</memoryMb>
+# <!-- one or more repetitions:-->
+# <disk id="x445fe05-7113-4988-9d2e-cbjt78eb2" scsiId="0" sizeGb="50"
+# speed="STANDARD" state="NORMAL"/>
+# <disk id="ef49974c-87d0-400f-aa32-ee43559fdb1b" scsiId="1" sizeGb="150"
+# speed="STANDARD" state="NORMAL"/>
+# <!--Zero or more repetitions:-->
+# <softwareLabel>REDHAT5ES64</softwareLabel>
+# <!--Optional:-->
+# <sourceImageId>5a18d6f0-eaca-11e1-8340-d93da27669ab</sourceImageId>
+# <networkId>xb632974c-87d0-400faa32-hb43559flk765</networkId>
+# © 2013 Dimension Data Cloud Solutions
+# 69
+# <machineName>10-157-3-125</machineName>
+# <privateIp>10.157.3.125</privateIp>
+# <!--Optional:-->
+# <publicIp>206.80.63.208</publicIp>
+# <created>2012-07-02T10:43:31.000Z</created>
+# <isStarted>false</isStarted>
+# <isDeployed>true</isDeployed>
+# <state>PENDING_CHANGE</state>
+# <!--Zero or more repetitions:-->
+# <machineStatus name="vmwareToolsRunningStatus">
+# <value>RUNNING</value>
+# </machineStatus>
+# <!--Optional:-->
+# <status>
+# <action>START_SERVER</action>
+# <requestTime>2012-09-26T08:36:28</requestTime>
+# <userName>btaylor</userName>
+# <!--Optional:-->
+# <numberOfSteps>3</numberOfSteps>
+# <!--Optional:-->
+# <updateTime>2012-09-26T08:37:28</updateTime>
+# <!--Optional:-->
+# <step>
+# <name>Waiting for operation</name>
+# <number>3</number>
+# <!--Optional:-->
+# <percentComplete>3</percentComplete>
+# </step>
+# <!--Optional: (present only if the last operation failed and left
+# the server in a locked state) -->
+# <failureReason>Message Value</failureReason>
+# </status>
+# </serverWithState>
+# </ServersWithState>