knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/lib/chef/knife/ionoscloud_share_update.rb

@@ -0,0 +1,70 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudShareUpdate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud share update (options)'
+
+      option :group_id,
+              short: '-G GROUP_ID',
+              long: '--group-id GROUP_ID',
+              description: 'ID of the group.'
+
+      option :resource_id,
+              short: '-R RESOURCE_ID',
+              long: '--resource-id RESOURCE_ID',
+              description: 'The ID of the resource.'
+
+      option :edit_privilege,
+              long: '--edit EDIT_PRIVILEGE',
+              description: 'The group has permission to edit privileges on this resource.'
+
+      option :share_privilege,
+              short: '-s SHARE_PRIVILEGE',
+              long: '--share SHARE_PRIVILEGE',
+              description: 'The group has permission to share this resource.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Updates information about a Ionoscloud Group Share.'
+        @required_options = [:group_id, :resource_id, :ionoscloud_username, :ionoscloud_password]
+        @updatable_fields = [:edit_privilege, :share_privilege]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        user_management_api = Ionoscloud::UserManagementApi.new(api_client)
+
+        if @updatable_fields.map { |el| config[el] }.any?
+          print "#{ui.color('Updating Group Share...', :magenta)}"
+
+          share = user_management_api.um_groups_shares_find_by_resource_id(config[:group_id], config[:resource_id])
+
+          new_share = Ionoscloud::GroupShare.new(
+            properties: Ionoscloud::GroupShareProperties.new(
+              edit_privilege: (config.key?(:edit_privilege) ? config[:edit_privilege].to_s.downcase == 'true' : share.properties.edit_privilege),
+              share_privilege: (config.key?(:share_privilege) ? config[:share_privilege].to_s.downcase == 'true' : share.properties.share_privilege),
+            ),
+          )
+
+          _, _, headers = user_management_api.um_groups_shares_put_with_http_info(config[:group_id], config[:resource_id], new_share)
+
+          dot = ui.color('.', :magenta)
+          api_client.wait_for { print dot; is_done? get_request_id headers }
+        else
+          ui.warn("Nothing to update, please set one of the attributes #{@updatable_fields}.")
+        end
+
+        print_share(user_management_api.um_groups_shares_find_by_resource_id(config[:group_id], config[:resource_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_snapshot_create.rb

@@ -17,6 +17,24 @@ class Chef
               long: '--volume VOLUME_ID',
               description: 'ID of the Volume'
 
+      option :name,
+              short: '-n SNAPSHOT_NAME',
+              long: '--name SNAPSHOT_NAME',
+              description: 'Name of the snapshot'
+
+      option :description,
+              long: '--description SNAPSHOT_DESCRIPTION',
+              description: 'Description of the snapshot'
+
+      option :sec_auth_protection,
+              long: '--sec-auth',
+              description: 'Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc.'
+
+      option :licence_type,
+              short: '-l LICENCE_TYPE',
+              long: '--licence LICENCE_TYPE',
+              description: 'The OS type of this Snapshot'
+
       attr_reader :description, :required_options
 
       def initialize(args = [])
@@ -29,6 +47,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         print "#{ui.color('Creating Snapshot...', :magenta)}"
@@ -38,20 +57,18 @@ class Chef
         snapshot, _, headers  = volume_api.datacenters_volumes_create_snapshot_post_with_http_info(
           config[:datacenter_id],
           config[:volume_id],
+          {
+            name: config[:name],
+            description: config[:description],
+            sec_auth_protection: config[:sec_auth_protection],
+            licence_type: config[:licence_type],
+          }.compact,
         )
 
         dot = ui.color('.', :magenta)
         api_client.wait_for { print dot; is_done? get_request_id headers }
 
-        snapshot = Ionoscloud::SnapshotApi.new(api_client).snapshots_find_by_id(snapshot.id)
-
-        puts "\n"
-        puts "#{ui.color('ID', :cyan)}: #{snapshot.id}"
-        puts "#{ui.color('Name', :cyan)}: #{snapshot.properties.name}"
-        puts "#{ui.color('Description', :cyan)}: #{snapshot.properties.description}"
-        puts "#{ui.color('Location', :cyan)}: #{snapshot.properties.location}"
-        puts "#{ui.color('Size', :cyan)}: #{snapshot.properties.size.to_s}"
-        puts 'done'
+        print_snapshot(Ionoscloud::SnapshotApi.new(api_client).snapshots_find_by_id(snapshot.id))
       end
     end
   end

data/lib/chef/knife/ionoscloud_snapshot_delete.rb

@@ -18,6 +18,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         snapshot_api = Ionoscloud::SnapshotApi.new(api_client)
@@ -31,12 +32,7 @@ class Chef
             next
           end
 
-          msg_pair('ID', snapshot.id)
-          msg_pair('Name', snapshot.properties.name)
-          msg_pair('Description', snapshot.properties.description)
-          msg_pair('Location', snapshot.properties.location)
-          msg_pair('Size', snapshot.properties.size.to_s)
-
+          print_snapshot(snapshot)
           puts "\n"
 
           begin

data/lib/chef/knife/ionoscloud_snapshot_get.rb

@@ -0,0 +1,32 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudSnapshotGet < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud snapshot get (options)'
+
+      option :snapshot_id,
+              short: '-S SNAPSHOT_ID',
+              long: '--snapshot-id SNAPSHOT_ID',
+              description: 'ID of the group.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Retrieves the attributes of a given Snapshot.'
+        @required_options = [:snapshot_id, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+        print_snapshot(Ionoscloud::SnapshotApi.new(api_client).snapshots_find_by_id(config[:snapshot_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_snapshot_list.rb

@@ -18,6 +18,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         snapshot_list = [

data/lib/chef/knife/ionoscloud_snapshot_restore.rb

@@ -34,6 +34,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         print "#{ui.color('Restoring Snapshot...', :magenta)}"

data/lib/chef/knife/ionoscloud_snapshot_update.rb

@@ -0,0 +1,126 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudSnapshotUpdate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud snapshot update (options)'
+
+      option :snapshot_id,
+              short: '-S SNAPSHOT_ID',
+              long: '--snapshot-id SNAPSHOT_ID',
+              description: 'ID of the Snapshot.'
+
+      option :name,
+              short: '-n NAME',
+              long: '--name NAME',
+              description: 'Name of the server'
+
+      option :description,
+              long: '--description DESCRIPTION',
+              description: 'The number of processor cores'
+
+      option :sec_auth_protection,
+              long: '--sec-auth-protection SEC_AUTH_PROTECTION',
+              description: 'Boolean value representing if the snapshot requires extra protection e.g. two factor protection'
+
+      option :licence_type,
+              short: '-l LICENCE',
+              long: '--licence-type LICENCE',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :cpu_hot_plug,
+              long: '--cpu-hot-plug CPU_HOT_PLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :cpu_hot_unplug,
+              long: '--cpu-hot-unplug CPU_HOT_UNPLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :ram_hot_plug,
+              long: '--ram-hot-plug RAM_HOT_PLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :ram_hot_unplug,
+              long: '--ram-hot-unplug RAM_HOT_UNPLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :nic_hot_plug,
+              long: '--nic-hot-plug NIC_HOT_PLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :nic_hot_unplug,
+              long: '--nic-hot-unplug NIC_HOT_UNPLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_virtio_hot_plug,
+              long: '--disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_virtio_hot_unplug,
+              long: '--disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_scsi_hot_plug,
+              long: '--disc-scsi-hot-plug DISC_SCSI_HOT_PLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_scsi_hot_unplug,
+              long: '--disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG',
+              description: 'The licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Updates information about a Ionoscloud Snapshot.'
+        @required_options = [:snapshot_id, :ionoscloud_username, :ionoscloud_password]
+        @updatable_fields = [
+          :name, :description, :sec_auth_protection, :licence_type, :cpu_hot_plug, :cpu_hot_unplug, :ram_hot_plug, :ram_hot_unplug,
+          :nic_hot_plug, :nic_hot_unplug, :disc_virtio_hot_plug, :disc_virtio_hot_unplug, :disc_scsi_hot_plug, :disc_scsi_hot_unplug,
+        ]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        server_api = Ionoscloud::SnapshotApi.new(api_client)
+
+        if @updatable_fields.map { |el| config[el] }.any?
+          print "#{ui.color('Updating Snapshot...', :magenta)}"
+
+          _, _, headers  = server_api.snapshots_patch_with_http_info(
+            config[:snapshot_id],
+            Ionoscloud::SnapshotProperties.new(
+              name: config[:name],
+              description: config[:description],
+              sec_auth_protection: (config.key?(:sec_auth_protection) ? config[:sec_auth_protection].to_s.downcase == 'true' : nil),
+              licence_type: config[:licence_type],
+              cpu_hot_plug: (config.key?(:cpu_hot_plug) ? config[:cpu_hot_plug].to_s.downcase == 'true' : nil),
+              cpu_hot_unplug: (config.key?(:cpu_hot_unplug) ? config[:cpu_hot_unplug].to_s.downcase == 'true' : nil),
+              ram_hot_plug: (config.key?(:ram_hot_plug) ? config[:ram_hot_plug].to_s.downcase == 'true' : nil),
+              ram_hot_unplug: (config.key?(:ram_hot_unplug) ? config[:ram_hot_unplug].to_s.downcase == 'true' : nil),
+              nic_hot_plug: (config.key?(:nic_hot_plug) ? config[:nic_hot_plug].to_s.downcase == 'true' : nil),
+              nic_hot_unplug: (config.key?(:nic_hot_unplug) ? config[:nic_hot_unplug].to_s.downcase == 'true' : nil),
+              disc_virtio_hot_plug: (config.key?(:disc_virtio_hot_plug) ? config[:disc_virtio_hot_plug].to_s.downcase == 'true' : nil),
+              disc_virtio_hot_unplug: (config.key?(:disc_virtio_hot_unplug) ? config[:disc_virtio_hot_unplug].to_s.downcase == 'true' : nil),
+              disc_scsi_hot_plug: (config.key?(:disc_scsi_hot_plug) ? config[:disc_scsi_hot_plug].to_s.downcase == 'true' : nil),
+              disc_scsi_hot_unplug: (config.key?(:disc_scsi_hot_unplug) ? config[:disc_scsi_hot_unplug].to_s.downcase == 'true' : nil),
+            ),
+          )
+
+          dot = ui.color('.', :magenta)
+          api_client.wait_for { print dot; is_done? get_request_id headers }
+        else
+          ui.warn("Nothing to update, please set one of the attributes #{@updatable_fields}.")
+        end
+
+        print_snapshot(server_api.snapshots_find_by_id(config[:snapshot_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_user_create.rb

@@ -18,7 +18,6 @@ class Chef
               description: 'Lastname of the user.'
 
       option :email,
-              short: '-e EMAIL',
               long: '--email EMAIL',
               description: 'An e-mail address for the user.'
 
@@ -33,50 +32,56 @@ class Chef
               description: 'Assigns the user have administrative rights.'
 
       option :force_sec_auth,
-              long: '--sec-auth SEC_AUTH',
+              long: '--force-sec-auth',
               description: 'Indicates if secure (two-factor) authentication should be forced for the user.'
 
+      option :sec_auth_active,
+              long: '--sec-auth',
+              description: 'Indicates if secure authentication is active for the user or not.'
+
+      option :active,
+              long: '--active',
+              description: 'Indicates if the user is active.'
+
       attr_reader :description, :required_options
 
       def initialize(args = [])
         super(args)
         @description =
-        "Creates a new user under a particular contract.\n**Please Note**: The password set "\
-        "here cannot be updated through the API currently. It is recommended that a new user "\
-        "log into the DCD and change their password."
+        'Creates a new user under a particular contract. **Please Note**: The password set '\
+        'here cannot be updated through the API currently. It is recommended that a new user '\
+        'log into the DCD and change their password.'
         @required_options = [:firstname, :lastname, :email, :password, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         print "#{ui.color('Creating user...', :magenta)}"
 
         user_management_api = Ionoscloud::UserManagementApi.new(api_client)
 
-        user, _, headers  = user_management_api.um_users_post_with_http_info({
-          properties: {
-            firstname: config[:firstname],
-            lastname: config[:lastname],
-            email: config[:email],
-            password: config[:password],
-            administrator: config[:administrator],
-            forceSecAuth: config[:force_sec_auth],
-          }.compact,
-        })
+        user, _, headers  = user_management_api.um_users_post_with_http_info(
+          Ionoscloud::UserPost.new(
+            properties: Ionoscloud::UserPropertiesPost.new(
+              firstname: config[:firstname],
+              lastname: config[:lastname],
+              email: config[:email],
+              password: config[:password],
+              administrator: config[:administrator],
+              force_sec_auth: config[:force_sec_auth],
+              sec_auth_active: config[:sec_auth_active],
+              active: config[:active],
+            ),
+          ),
+        )
 
         dot = ui.color('.', :magenta)
         api_client.wait_for { print dot; is_done? get_request_id headers }
 
-        puts "\n"
-        puts "#{ui.color('ID', :cyan)}: #{user.id}"
-        puts "#{ui.color('Firstname', :cyan)}: #{user.properties.firstname}"
-        puts "#{ui.color('Lastname', :cyan)}: #{user.properties.lastname}"
-        puts "#{ui.color('Email', :cyan)}: #{user.properties.email}"
-        puts "#{ui.color('Administrator', :cyan)}: #{user.properties.administrator.to_s}"
-        puts "#{ui.color('2-Factor Auth', :cyan)}: #{user.properties.force_sec_auth.to_s}"
-        puts 'done'
+        print_user(user)
       end
     end
   end

data/lib/chef/knife/ionoscloud_user_delete.rb

@@ -20,6 +20,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         user_management_api = Ionoscloud::UserManagementApi.new(api_client)
@@ -33,13 +34,7 @@ class Chef
             next
           end
 
-          msg_pair('ID', user.id)
-          msg_pair('Firstname', user.properties.firstname)
-          msg_pair('Lastname', user.properties.lastname)
-          msg_pair('Email', user.properties.email)
-          msg_pair('Administrator', user.properties.administrator.to_s)
-          msg_pair('2-Factor Auth', user.properties.force_sec_auth.to_s)
-          puts "\n"
+          print_user(user)
 
           begin
             confirm('Do you really want to delete this User')

data/lib/chef/knife/ionoscloud_user_get.rb

@@ -0,0 +1,32 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudUserGet < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud user get (options)'
+
+      option :user_id,
+              short: '-U USER_ID',
+              long: '--user-id USER_ID',
+              description: 'ID of the group.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Retrieves the attributes of a given Ionoscloud User.'
+        @required_options = [:user_id, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+        print_user(Ionoscloud::UserManagementApi.new(api_client).um_users_find_by_id(config[:user_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_user_list.rb

@@ -19,12 +19,13 @@ class Chef
         @description =
         'Retrieve a list of all the users that have been created under a contract. '\
         'You can retrieve a list of users who are members of the group by passing the '\
-        '*group_id* option.'
+        '_group\_id_ option.'
         @required_options = [:ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         user_list = [

data/lib/chef/knife/ionoscloud_user_ssourl.rb

@@ -23,6 +23,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         begin

data/lib/chef/knife/ionoscloud_user_update.rb

@@ -0,0 +1,92 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudUserUpdate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud user update (options)'
+
+      option :user_id,
+              short: '-U USER_ID',
+              long: '--user-id USER_ID',
+              description: 'ID of the User.'
+
+      option :firstname,
+              short: '-f FIRSTNAME',
+              long: '--firstname FIRSTNAME',
+              description: 'Firstname of the user.'
+
+      option :lastname,
+              short: '-l LASTNAME',
+              long: '--lastname LASTNAME',
+              description: 'Lastname of the user.'
+
+      option :email,
+              long: '--email EMAIL',
+              description: 'An e-mail address for the user.'
+
+      option :administrator,
+              short: '-a ADMIN',
+              long: '--admin ADMIN',
+              description: 'Assigns the user have administrative rights.'
+
+      option :force_sec_auth,
+              long: '--sec-auth FORCE_SEC_AUTH',
+              description: 'Indicates if secure (two-factor) authentication should be forced for the user.'
+
+      option :sec_auth_active,
+              long: '--sec-auth SEC_AUTH_ACTIVE',
+              description: 'Indicates if secure authentication is active for the user or not.'
+
+      option :active,
+              long: '--active ACTIVE',
+              description: 'Indicates if the user is active.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Updates information about a Ionoscloud User.'
+        @required_options = [:user_id, :ionoscloud_username, :ionoscloud_password]
+        @updatable_fields = [:firstname, :lastname, :email, :administrator, :force_sec_auth, :sec_auth_active, :active]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        user_management_api = Ionoscloud::UserManagementApi.new(api_client)
+
+        if @updatable_fields.map { |el| config[el] }.any?
+          print "#{ui.color('Updating User...', :magenta)}"
+
+          user = user_management_api.um_users_find_by_id(config[:user_id])
+
+          new_user = Ionoscloud::UserPut.new(
+            properties: Ionoscloud::UserPropertiesPut.new(
+              firstname: config[:firstname] || user.properties.firstname,
+              lastname: config[:lastname] || user.properties.lastname,
+              email: config[:email] || user.properties.email,
+              administrator: (config.key?(:administrator) ? config[:administrator].to_s.downcase == 'true' : user.properties.administrator),
+              force_sec_auth: (config.key?(:force_sec_auth) ? config[:force_sec_auth].to_s.downcase == 'true' : user.properties.force_sec_auth),
+              sec_auth_active: (config.key?(:sec_auth_active) ? config[:sec_auth_active].to_s.downcase == 'true' : user.properties.sec_auth_active),
+              active: (config.key?(:active) ? config[:active].to_s.downcase == 'true' : user.properties.active),
+            ),
+          )
+
+          _, _, headers  = user_management_api.um_users_put_with_http_info(config[:user_id], new_user)
+
+          dot = ui.color('.', :magenta)
+          api_client.wait_for { print dot; is_done? get_request_id headers }
+        else
+          ui.warn("Nothing to update, please set one of the attributes #{@updatable_fields}.")
+        end
+
+        print_user(user_management_api.um_users_find_by_id(config[:user_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_volume_attach.rb

@@ -28,6 +28,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         server_api = Ionoscloud::ServerApi.new(api_client)