[compute|cloudstack] added domain management support, added documentation links to existing cloudstack requests

2022-11-09 13:51:43 -05:00 · 2011-08-02 15:18:00 -04:00 · 2011-08-02 15:18:00 -04:00 · 81841f2357
commit 81841f2357
parent 263fe7ce81
43 changed files with 199 additions and 9 deletions
--- a/lib/fog/compute/requests/cloudstack/create_account.rb
+++ b/lib/fog/compute/requests/cloudstack/create_account.rb
@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Cloudstack
+      class Real
+
+        # Creates an account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/createAccount.html]
+        def create_account(options={})
+          options.merge!(
+            'command' => 'createAccount'
+          )
+
+          request(options)
+        end
+
+      end
+    end
+  end
+end
--- a/lib/fog/compute/requests/cloudstack/create_domain.rb
+++ b/lib/fog/compute/requests/cloudstack/create_domain.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Creates a domain.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/createDomain.html]
        def create_domain(options={})
--- a/lib/fog/compute/requests/cloudstack/create_user.rb
+++ b/lib/fog/compute/requests/cloudstack/create_user.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Creates a user for an account that already exists.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/createUser.html]
        def create_user(options={})
--- a/lib/fog/compute/requests/cloudstack/delete_account.rb
+++ b/lib/fog/compute/requests/cloudstack/delete_account.rb
@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Cloudstack
+      class Real
+
+        # Deletes a account, and all users associated with this account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/deleteAccount.html]
+        def delete_account(options={})
+          options.merge!(
+            'command' => 'deleteAccount'
+          )
+
+          request(options)
+        end
+
+      end
+    end
+  end
+end
--- a/lib/fog/compute/requests/cloudstack/delete_domain.rb
+++ b/lib/fog/compute/requests/cloudstack/delete_domain.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Deletes a specified domain.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/deleteDomain.html]
        def delete_domain(options={})
--- a/lib/fog/compute/requests/cloudstack/delete_user.rb
+++ b/lib/fog/compute/requests/cloudstack/delete_user.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Deletes a specified user.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/deleteUser.html]
        def delete_user(options={})
--- a/lib/fog/compute/requests/cloudstack/disable_account.rb
+++ b/lib/fog/compute/requests/cloudstack/disable_account.rb
@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Cloudstack
+      class Real
+
+        # Disables an account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/disableAccount.html]
+        def disable_account(options={})
+          options.merge!(
+            'command' => 'disableAccount'
+          )
+
+          request(options)
+        end
+
+      end
+    end
+  end
+end
--- a/lib/fog/compute/requests/cloudstack/disable_user.rb
+++ b/lib/fog/compute/requests/cloudstack/disable_user.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Disables a user account.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/disableUser.html]
        def disable_user(options={})
--- a/lib/fog/compute/requests/cloudstack/enable_account.rb
+++ b/lib/fog/compute/requests/cloudstack/enable_account.rb
@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Cloudstack
+      class Real
+
+        # Enables an account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/enableAccount.html]
+        def enable_account(options={})
+          options.merge!(
+            'command' => 'enableAccount'
+          )
+
+          request(options)
+        end
+
+      end
+    end
+  end
+end
--- a/lib/fog/compute/requests/cloudstack/enable_user.rb
+++ b/lib/fog/compute/requests/cloudstack/enable_user.rb
@ -3,9 +3,9 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Enables a user account.
        #
-        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/disableUser.html]
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/enableUser.html]
        def enable_user(options={})
          options.merge!(
            'command' => 'enableUser'
--- a/lib/fog/compute/requests/cloudstack/list_accounts.rb
+++ b/lib/fog/compute/requests/cloudstack/list_accounts.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists accounts and provides detailed account information for listed accounts.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listAccounts.html]
        def list_accounts(options={})
          options.merge!(
            'command' => 'listAccounts'
--- a/lib/fog/compute/requests/cloudstack/list_alerts.rb
+++ b/lib/fog/compute/requests/cloudstack/list_alerts.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all alerts.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listAlerts.html]
        def list_alerts(options={})
          options.merge!(
            'command' => 'listAlerts'
--- a/lib/fog/compute/requests/cloudstack/list_async_jobs.rb
+++ b/lib/fog/compute/requests/cloudstack/list_async_jobs.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all pending asynchronous jobs for the account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listAsyncJobs.html]
        def list_async_jobs(options={})
          options.merge!(
            'command' => 'listAsyncJobs'
--- a/lib/fog/compute/requests/cloudstack/list_disk_offerings.rb
+++ b/lib/fog/compute/requests/cloudstack/list_disk_offerings.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available disk offerings.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listDiskOfferings.html]
        def list_disk_offerings(options={})
          options.merge!(
            'command' => 'listDiskOfferings'
--- a/lib/fog/compute/requests/cloudstack/list_domain_children.rb
+++ b/lib/fog/compute/requests/cloudstack/list_domain_children.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all children domains belonging to a specified domain.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listDomainChildren.html]
        def list_domain_children(options={})
          options.merge!(
            'command' => 'listDomainChildren'
--- a/lib/fog/compute/requests/cloudstack/list_domains.rb
+++ b/lib/fog/compute/requests/cloudstack/list_domains.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists domains and provides detailed information for listed domains.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listDomains.html]
        def list_domains(options={})
          options.merge!(
            'command' => 'listDomains'
--- a/lib/fog/compute/requests/cloudstack/list_events.rb
+++ b/lib/fog/compute/requests/cloudstack/list_events.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # A command to list events.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listEvents.html]
        def list_events(options={})
          options.merge!(
            'command' => 'listEvents'
--- a/lib/fog/compute/requests/cloudstack/list_external_firewalls.rb
+++ b/lib/fog/compute/requests/cloudstack/list_external_firewalls.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # List external firewall appliances.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listExternalFirewalls.html]
        def list_external_firewalls(options={})
          options.merge!(
            'command' => 'listExternalFirewalls'
--- a/lib/fog/compute/requests/cloudstack/list_external_load_balancers.rb
+++ b/lib/fog/compute/requests/cloudstack/list_external_load_balancers.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # List external load balancer appliances.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listExternalLoadBalancers.html]
        def list_external_load_balancers(options={})
          options.merge!(
            'command' => 'listExternalLoadBalancers'
--- a/lib/fog/compute/requests/cloudstack/list_hosts.rb
+++ b/lib/fog/compute/requests/cloudstack/list_hosts.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists hosts.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listHosts.html]
        def list_hosts(options={})
          options.merge!(
            'command' => 'listHosts'
--- a/lib/fog/compute/requests/cloudstack/list_hypervisors.rb
+++ b/lib/fog/compute/requests/cloudstack/list_hypervisors.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists hypervisors.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listHypervisors.html]
        def list_hypervisors(options={})
          options.merge!(
            'command' => 'listHypervisors'
--- a/lib/fog/compute/requests/cloudstack/list_instance_groups.rb
+++ b/lib/fog/compute/requests/cloudstack/list_instance_groups.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists VM groups.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listInstanceGroups.html]
        def list_instance_groups(options={})
          options.merge!(
            'command' => 'listInstanceGroups'
--- a/lib/fog/compute/requests/cloudstack/list_isos.rb
+++ b/lib/fog/compute/requests/cloudstack/list_isos.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available ISO files.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listIsos.html]
        def list_isos(options={})
          options.merge!(
            'command' => 'listIsos'
--- a/lib/fog/compute/requests/cloudstack/list_network_offerings.rb
+++ b/lib/fog/compute/requests/cloudstack/list_network_offerings.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available network offerings.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listNetworkOfferings.html]
        def list_network_offerings(options={})
          options.merge!(
            'command' => 'listNetworkOfferings'
--- a/lib/fog/compute/requests/cloudstack/list_networks.rb
+++ b/lib/fog/compute/requests/cloudstack/list_networks.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available networks.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listNetworks.html]
        def list_networks(options={})
          options.merge!(
            'command' => 'listNetworks'
--- a/lib/fog/compute/requests/cloudstack/list_os_categories.rb
+++ b/lib/fog/compute/requests/cloudstack/list_os_categories.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all supported OS categories for this cloud.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listOsCategories.html]
        def list_os_categories(options={})
          options.merge!(
            'command' => 'listOsCategories'
--- a/lib/fog/compute/requests/cloudstack/list_os_types.rb
+++ b/lib/fog/compute/requests/cloudstack/list_os_types.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all supported OS types for this cloud.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listOsTypes.html]
        def list_os_types(options={})
          options.merge!(
            'command' => 'listOsTypes'
--- a/lib/fog/compute/requests/cloudstack/list_pods.rb
+++ b/lib/fog/compute/requests/cloudstack/list_pods.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all Pods.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listPods.html]
        def list_pods(options={})
          options.merge!(
            'command' => 'listPods'
--- a/lib/fog/compute/requests/cloudstack/list_resource_limits.rb
+++ b/lib/fog/compute/requests/cloudstack/list_resource_limits.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists resource limits.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listResourceLimits.html]
        def list_resource_limits(options={})
          options.merge!(
            'command' => 'listResourceLimits'
--- a/lib/fog/compute/requests/cloudstack/list_security_groups.rb
+++ b/lib/fog/compute/requests/cloudstack/list_security_groups.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists security groups.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listSecurityGroups.html]
        def list_security_groups(options={})
          options.merge!(
            'command' => 'listSecurityGroups'
--- a/lib/fog/compute/requests/cloudstack/list_service_offerings.rb
+++ b/lib/fog/compute/requests/cloudstack/list_service_offerings.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available service offerings.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listServiceOfferings.html]
        def list_service_offerings(options={})
          options.merge!(
            'command' => 'listServiceOfferings'
--- a/lib/fog/compute/requests/cloudstack/list_snapshots.rb
+++ b/lib/fog/compute/requests/cloudstack/list_snapshots.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all available snapshots for the account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listSnapshots.html]
        def list_snapshots(options={})
          options.merge!(
            'command' => 'listSnapshots'
--- a/lib/fog/compute/requests/cloudstack/list_ssh_key_pairs.rb
+++ b/lib/fog/compute/requests/cloudstack/list_ssh_key_pairs.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # List registered keypairs.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listSSHKeyPairs.html]
        def list_ssh_key_pairs(options={})
          options.merge!(
            'command' => 'listSSHKeyPairs'
--- a/lib/fog/compute/requests/cloudstack/list_storage_pools.rb
+++ b/lib/fog/compute/requests/cloudstack/list_storage_pools.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists storage pools.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listStoragePools.html]
        def list_storage_pools(options={})
          options.merge!(
            'command' => 'listStoragePools'
--- a/lib/fog/compute/requests/cloudstack/list_templates.rb
+++ b/lib/fog/compute/requests/cloudstack/list_templates.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # List all public, private, and privileged templates.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listTemplates.html]
        def list_templates(options={})
          options.merge!(
            'command' => 'listTemplates'
--- a/lib/fog/compute/requests/cloudstack/list_usage_records.rb
+++ b/lib/fog/compute/requests/cloudstack/list_usage_records.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists usage records for accounts.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listUsageRecords.html]
        def list_usage_records(options={})
          options.merge!(
            'command' => 'listUsageRecords'
--- a/lib/fog/compute/requests/cloudstack/list_users.rb
+++ b/lib/fog/compute/requests/cloudstack/list_users.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists user accounts.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listUsers.html]
        def list_users(options={})
          options.merge!(
            'command' => 'listUsers'
--- a/lib/fog/compute/requests/cloudstack/list_virtual_machines.rb
+++ b/lib/fog/compute/requests/cloudstack/list_virtual_machines.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # List the virtual machines owned by the account.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listVirtualMachines.html]
        def list_virtual_machines(options={})
          options.merge!(
            'command' => 'listVirtualMachines'
--- a/lib/fog/compute/requests/cloudstack/list_volumes.rb
+++ b/lib/fog/compute/requests/cloudstack/list_volumes.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists all volumes.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listVolumes.html]
        def list_volumes(options={})
          options.merge!(
            'command' => 'listVolumes'
--- a/lib/fog/compute/requests/cloudstack/list_zones.rb
+++ b/lib/fog/compute/requests/cloudstack/list_zones.rb
@ -3,6 +3,9 @@ module Fog
    class Cloudstack
      class Real

+        # Lists zones.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/listZones.html]
        def list_zones(options={})
          options.merge!(
            'command' => 'listZones'
--- a/lib/fog/compute/requests/cloudstack/update_account.rb
+++ b/lib/fog/compute/requests/cloudstack/update_account.rb
@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Cloudstack
+      class Real
+
+        # Updates account information for the authenticated user.
+        #
+        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/updateAccount.html]
+        def update_account(options={})
+          options.merge!(
+            'command' => 'updateAccount'
+          )
+
+          request(options)
+        end
+
+      end
+    end
+  end
+end
--- a/lib/fog/compute/requests/cloudstack/update_domain.rb
+++ b/lib/fog/compute/requests/cloudstack/update_domain.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Updates a domain with a new name.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/updateDomain.html]
        def update_domain(options={})
--- a/lib/fog/compute/requests/cloudstack/update_user.rb
+++ b/lib/fog/compute/requests/cloudstack/update_user.rb
@ -3,7 +3,7 @@ module Fog
    class Cloudstack
      class Real

-        # Creates a user for an account that already exists
+        # Updates a user account.
        #
        # {CloudStack API Reference}[http://download.cloud.com/releases/2.2.0/api_2.2.4/global_admin/updateUser.html]
        def update_user(options={})