knife-ionoscloud 6.0.0.beta.2 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (187) hide show
  1. checksums.yaml +4 -4
  2. data/docs/README.md +11 -0
  3. data/docs/subcommands/backupunit_create.md +7 -4
  4. data/docs/subcommands/backupunit_delete.md +6 -3
  5. data/docs/subcommands/backupunit_get.md +38 -0
  6. data/docs/subcommands/backupunit_list.md +6 -3
  7. data/docs/subcommands/backupunit_ssourl.md +6 -3
  8. data/docs/subcommands/backupunit_update.md +44 -0
  9. data/docs/subcommands/composite_server_create.md +8 -11
  10. data/docs/subcommands/contract_list.md +6 -3
  11. data/docs/subcommands/cube_server_create.md +6 -3
  12. data/docs/subcommands/datacenter_create.md +6 -3
  13. data/docs/subcommands/datacenter_delete.md +6 -3
  14. data/docs/subcommands/datacenter_get.md +38 -0
  15. data/docs/subcommands/datacenter_list.md +6 -3
  16. data/docs/subcommands/datacenter_update.md +47 -0
  17. data/docs/subcommands/firewall_create.md +8 -8
  18. data/docs/subcommands/firewall_delete.md +5 -2
  19. data/docs/subcommands/firewall_get.md +50 -0
  20. data/docs/subcommands/firewall_list.md +6 -3
  21. data/docs/subcommands/firewall_update.md +74 -0
  22. data/docs/subcommands/flowlog_create.md +6 -3
  23. data/docs/subcommands/flowlog_delete.md +6 -3
  24. data/docs/subcommands/flowlog_get.md +58 -0
  25. data/docs/subcommands/flowlog_list.md +6 -3
  26. data/docs/subcommands/flowlog_update.md +70 -0
  27. data/docs/subcommands/group_create.md +6 -12
  28. data/docs/subcommands/group_delete.md +6 -3
  29. data/docs/subcommands/group_get.md +6 -3
  30. data/docs/subcommands/group_list.md +6 -3
  31. data/docs/subcommands/group_update.md +68 -0
  32. data/docs/subcommands/group_user_add.md +5 -2
  33. data/docs/subcommands/group_user_remove.md +5 -2
  34. data/docs/subcommands/image_list.md +6 -3
  35. data/docs/subcommands/ipblock_create.md +6 -3
  36. data/docs/subcommands/ipblock_delete.md +6 -3
  37. data/docs/subcommands/ipblock_get.md +38 -0
  38. data/docs/subcommands/ipblock_list.md +6 -3
  39. data/docs/subcommands/ipblock_update.md +41 -0
  40. data/docs/subcommands/ipfailover_add.md +6 -3
  41. data/docs/subcommands/ipfailover_remove.md +6 -3
  42. data/docs/subcommands/k8s_create.md +13 -10
  43. data/docs/subcommands/k8s_delete.md +6 -3
  44. data/docs/subcommands/k8s_get.md +38 -0
  45. data/docs/subcommands/k8s_list.md +6 -3
  46. data/docs/subcommands/k8s_update.md +56 -0
  47. data/docs/subcommands/kubeconfig_get.md +6 -3
  48. data/docs/subcommands/label_add.md +6 -3
  49. data/docs/subcommands/label_list.md +6 -3
  50. data/docs/subcommands/label_remove.md +5 -2
  51. data/docs/subcommands/lan_create.md +6 -3
  52. data/docs/subcommands/lan_delete.md +5 -2
  53. data/docs/subcommands/lan_get.md +42 -0
  54. data/docs/subcommands/lan_list.md +6 -3
  55. data/docs/subcommands/lan_update.md +54 -0
  56. data/docs/subcommands/loadbalancer_create.md +7 -4
  57. data/docs/subcommands/loadbalancer_delete.md +5 -2
  58. data/docs/subcommands/loadbalancer_get.md +6 -3
  59. data/docs/subcommands/loadbalancer_list.md +6 -3
  60. data/docs/subcommands/loadbalancer_nic_add.md +5 -2
  61. data/docs/subcommands/loadbalancer_nic_remove.md +5 -2
  62. data/docs/subcommands/loadbalancer_update.md +51 -0
  63. data/docs/subcommands/location_list.md +6 -3
  64. data/docs/subcommands/natgateway_create.md +8 -5
  65. data/docs/subcommands/natgateway_delete.md +5 -2
  66. data/docs/subcommands/natgateway_get.md +42 -0
  67. data/docs/subcommands/natgateway_lan_add.md +6 -3
  68. data/docs/subcommands/natgateway_lan_remove.md +5 -2
  69. data/docs/subcommands/natgateway_list.md +6 -3
  70. data/docs/subcommands/natgateway_rule_add.md +7 -4
  71. data/docs/subcommands/natgateway_rule_list.md +6 -3
  72. data/docs/subcommands/natgateway_rule_remove.md +5 -2
  73. data/docs/subcommands/natgateway_rule_update.md +69 -0
  74. data/docs/subcommands/natgateway_update.md +51 -0
  75. data/docs/subcommands/networkloadbalancer_create.md +6 -3
  76. data/docs/subcommands/networkloadbalancer_delete.md +5 -2
  77. data/docs/subcommands/networkloadbalancer_get.md +42 -0
  78. data/docs/subcommands/networkloadbalancer_list.md +6 -3
  79. data/docs/subcommands/networkloadbalancer_rule_add.md +9 -6
  80. data/docs/subcommands/networkloadbalancer_rule_list.md +6 -3
  81. data/docs/subcommands/networkloadbalancer_rule_remove.md +5 -2
  82. data/docs/subcommands/networkloadbalancer_rule_target_add.md +6 -3
  83. data/docs/subcommands/networkloadbalancer_rule_target_list.md +6 -3
  84. data/docs/subcommands/networkloadbalancer_rule_target_remove.md +6 -3
  85. data/docs/subcommands/networkloadbalancer_rule_update.md +75 -0
  86. data/docs/subcommands/networkloadbalancer_update.md +57 -0
  87. data/docs/subcommands/nic_create.md +9 -6
  88. data/docs/subcommands/nic_delete.md +6 -3
  89. data/docs/subcommands/nic_get.md +46 -0
  90. data/docs/subcommands/nic_list.md +6 -3
  91. data/docs/subcommands/nic_update.md +61 -0
  92. data/docs/subcommands/node_delete.md +5 -2
  93. data/docs/subcommands/node_get.md +46 -0
  94. data/docs/subcommands/node_list.md +6 -3
  95. data/docs/subcommands/node_replace.md +5 -2
  96. data/docs/subcommands/nodepool_create.md +16 -7
  97. data/docs/subcommands/nodepool_delete.md +5 -2
  98. data/docs/subcommands/nodepool_get.md +42 -0
  99. data/docs/subcommands/nodepool_lan_add.md +6 -3
  100. data/docs/subcommands/nodepool_lan_remove.md +5 -2
  101. data/docs/subcommands/nodepool_list.md +6 -3
  102. data/docs/subcommands/nodepool_update.md +72 -0
  103. data/docs/subcommands/pcc_create.md +6 -3
  104. data/docs/subcommands/pcc_delete.md +6 -3
  105. data/docs/subcommands/pcc_get.md +38 -0
  106. data/docs/subcommands/pcc_list.md +6 -3
  107. data/docs/subcommands/pcc_update.md +44 -0
  108. data/docs/subcommands/request_get.md +38 -0
  109. data/docs/subcommands/request_list.md +6 -3
  110. data/docs/subcommands/request_status.md +6 -3
  111. data/docs/subcommands/request_wait.md +6 -3
  112. data/docs/subcommands/resource_list.md +6 -3
  113. data/docs/subcommands/s3key_create.md +6 -3
  114. data/docs/subcommands/s3key_delete.md +5 -2
  115. data/docs/subcommands/s3key_get.md +42 -0
  116. data/docs/subcommands/s3key_list.md +6 -3
  117. data/docs/subcommands/server_console.md +6 -3
  118. data/docs/subcommands/server_create.md +6 -3
  119. data/docs/subcommands/server_delete.md +5 -2
  120. data/docs/subcommands/server_get.md +42 -0
  121. data/docs/subcommands/server_list.md +6 -6
  122. data/docs/subcommands/server_reboot.md +5 -2
  123. data/docs/subcommands/server_resume.md +5 -2
  124. data/docs/subcommands/server_start.md +5 -2
  125. data/docs/subcommands/server_stop.md +5 -2
  126. data/docs/subcommands/server_suspend.md +5 -2
  127. data/docs/subcommands/server_token.md +6 -3
  128. data/docs/subcommands/server_update.md +63 -0
  129. data/docs/subcommands/server_upgrade.md +6 -3
  130. data/docs/subcommands/share_create.md +7 -4
  131. data/docs/subcommands/share_delete.md +7 -4
  132. data/docs/subcommands/share_get.md +42 -0
  133. data/docs/subcommands/share_list.md +6 -3
  134. data/docs/subcommands/share_update.md +48 -0
  135. data/docs/subcommands/snapshot_create.md +6 -3
  136. data/docs/subcommands/snapshot_delete.md +6 -3
  137. data/docs/subcommands/snapshot_get.md +38 -0
  138. data/docs/subcommands/snapshot_list.md +6 -3
  139. data/docs/subcommands/snapshot_restore.md +6 -3
  140. data/docs/subcommands/snapshot_update.md +80 -0
  141. data/docs/subcommands/template_list.md +6 -3
  142. data/docs/subcommands/user_create.md +14 -5
  143. data/docs/subcommands/user_delete.md +6 -3
  144. data/docs/subcommands/user_get.md +38 -0
  145. data/docs/subcommands/user_list.md +6 -3
  146. data/docs/subcommands/user_ssourl.md +6 -3
  147. data/docs/subcommands/user_update.md +59 -0
  148. data/docs/subcommands/volume_attach.md +5 -2
  149. data/docs/subcommands/volume_create.md +28 -4
  150. data/docs/subcommands/volume_delete.md +5 -2
  151. data/docs/subcommands/volume_detach.md +5 -2
  152. data/docs/subcommands/volume_get.md +42 -0
  153. data/docs/subcommands/volume_list.md +6 -3
  154. data/docs/subcommands/volume_update.md +69 -0
  155. data/docs/summary.md +41 -0
  156. data/knife-ionoscloud.gemspec +1 -1
  157. data/lib/chef/knife/ionoscloud_base.rb +29 -1
  158. data/lib/chef/knife/ionoscloud_composite_server_create.rb +3 -7
  159. data/lib/chef/knife/ionoscloud_firewall_create.rb +1 -3
  160. data/lib/chef/knife/ionoscloud_firewall_update.rb +0 -1
  161. data/lib/chef/knife/ionoscloud_flowlog_create.rb +0 -2
  162. data/lib/chef/knife/ionoscloud_flowlog_update.rb +0 -2
  163. data/lib/chef/knife/ionoscloud_ipfailover_add.rb +1 -1
  164. data/lib/chef/knife/ionoscloud_ipfailover_remove.rb +1 -1
  165. data/lib/chef/knife/ionoscloud_lan_create.rb +1 -2
  166. data/lib/chef/knife/ionoscloud_lan_delete.rb +1 -1
  167. data/lib/chef/knife/ionoscloud_lan_get.rb +1 -1
  168. data/lib/chef/knife/ionoscloud_lan_list.rb +1 -1
  169. data/lib/chef/knife/ionoscloud_lan_update.rb +1 -1
  170. data/lib/chef/knife/ionoscloud_natgateway_rule_add.rb +2 -4
  171. data/lib/chef/knife/ionoscloud_networkloadbalancer_rule_add.rb +6 -12
  172. data/lib/chef/knife/ionoscloud_networkloadbalancer_rule_target_add.rb +1 -2
  173. data/lib/chef/knife/ionoscloud_nic_create.rb +1 -3
  174. data/lib/chef/knife/ionoscloud_nodepool_create.rb +3 -6
  175. data/lib/chef/knife/ionoscloud_nodepool_lan_add.rb +0 -1
  176. data/lib/chef/knife/ionoscloud_pcc_create.rb +1 -1
  177. data/lib/chef/knife/ionoscloud_server_create.rb +2 -4
  178. data/lib/knife-ionoscloud/version.rb +1 -1
  179. data/spec/chef/knife/ionoscloud_ipfailover_add_spec.rb +3 -3
  180. data/spec/chef/knife/ionoscloud_ipfailover_remove_spec.rb +4 -4
  181. data/spec/chef/knife/ionoscloud_lan_create_spec.rb +3 -3
  182. data/spec/chef/knife/ionoscloud_lan_delete_spec.rb +5 -5
  183. data/spec/chef/knife/ionoscloud_lan_get_spec.rb +2 -2
  184. data/spec/chef/knife/ionoscloud_lan_list_spec.rb +2 -2
  185. data/spec/chef/knife/ionoscloud_lan_update_spec.rb +3 -3
  186. data/spec/chef/knife/ionoscloud_pcc_create_spec.rb +2 -2
  187. metadata +47 -6
@@ -0,0 +1,38 @@
1
+ # SnapshotGet
2
+
3
+ Retrieves the attributes of a given Snapshot.
4
+
5
+ ```text
6
+ knife ionoscloud snapshot get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * snapshot\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
21
+ snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_ID
22
+ iD of the group. (required)
23
+
24
+ ionoscloud_username: --username USERNAME, -u USERNAME
25
+ your Ionoscloud username (required)
26
+
27
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
28
+ your Ionoscloud password (required)
29
+
30
+ ionoscloud_url: --url URL
31
+ the Ionoscloud API URL
32
+
33
+ ```
34
+ ## Example
35
+
36
+ ```text
37
+ knife ionoscloud snapshot get --extra-config EXTRA_CONFIG_FILE_PATH --snapshot-id SNAPSHOT_ID --username USERNAME --password PASSWORD --url URL
38
+ ```
@@ -14,18 +14,21 @@ knife ionoscloud snapshot list
14
14
  * ionoscloud\_password
15
15
 
16
16
  ```text
17
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
18
+ path to the additional config file
19
+
17
20
  ionoscloud_username: --username USERNAME, -u USERNAME
18
21
  your Ionoscloud username (required)
19
22
 
20
23
  ionoscloud_password: --password PASSWORD, -p PASSWORD
21
24
  your Ionoscloud password (required)
22
25
 
23
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
24
- path to the additional config file
26
+ ionoscloud_url: --url URL
27
+ the Ionoscloud API URL
25
28
 
26
29
  ```
27
30
  ## Example
28
31
 
29
32
  ```text
30
- knife ionoscloud snapshot list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud snapshot list--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -17,6 +17,9 @@ knife ionoscloud snapshot restore (options)
17
17
  * ionoscloud\_password
18
18
 
19
19
  ```text
20
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
21
+ path to the additional config file
22
+
20
23
  datacenter_id: --datacenter DATACENTER_ID, -D DATACENTER_ID
21
24
  iD of the Datacenter (required)
22
25
 
@@ -32,12 +35,12 @@ knife ionoscloud snapshot restore (options)
32
35
  ionoscloud_password: --password PASSWORD, -p PASSWORD
33
36
  your Ionoscloud password (required)
34
37
 
35
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
36
- path to the additional config file
38
+ ionoscloud_url: --url URL
39
+ the Ionoscloud API URL
37
40
 
38
41
  ```
39
42
  ## Example
40
43
 
41
44
  ```text
42
- knife ionoscloud snapshot restore --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
45
+ knife ionoscloud snapshot restore --extra-config EXTRA_CONFIG_FILE_PATH --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD --url URL
43
46
  ```
@@ -0,0 +1,80 @@
1
+ # SnapshotUpdate
2
+
3
+ Updates information about a Ionoscloud Snapshot.
4
+
5
+ ```text
6
+ knife ionoscloud snapshot update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * snapshot\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
21
+ snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_ID
22
+ iD of the Snapshot. (required)
23
+
24
+ name: --name NAME, -n NAME
25
+ name of the server
26
+
27
+ description: --description DESCRIPTION
28
+ the number of processor cores
29
+
30
+ sec_auth_protection: --sec-auth-protection SEC_AUTH_PROTECTION
31
+ boolean value representing if the snapshot requires extra protection e.g. two factor protection
32
+
33
+ licence_type: --licence-type LICENCE, -l LICENCE
34
+ the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
35
+
36
+ cpu_hot_plug: --cpu-hot-plug CPU_HOT_PLUG
37
+ is capable of CPU hot plug (no reboot required)
38
+
39
+ cpu_hot_unplug: --cpu-hot-unplug CPU_HOT_UNPLUG
40
+ is capable of CPU hot unplug (no reboot required)
41
+
42
+ ram_hot_plug: --ram-hot-plug RAM_HOT_PLUG
43
+ is capable of memory hot plug (no reboot required)
44
+
45
+ ram_hot_unplug: --ram-hot-unplug RAM_HOT_UNPLUG
46
+ is capable of memory hot unplug (no reboot required)
47
+
48
+ nic_hot_plug: --nic-hot-plug NIC_HOT_PLUG
49
+ is capable of nic hot plug (no reboot required)
50
+
51
+ nic_hot_unplug: --nic-hot-unplug NIC_HOT_UNPLUG
52
+ is capable of nic hot unplug (no reboot required)
53
+
54
+ disc_virtio_hot_plug: --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG
55
+ is capable of Virt-IO drive hot plug (no reboot required)
56
+
57
+ disc_virtio_hot_unplug: --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG
58
+ is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.
59
+
60
+ disc_scsi_hot_plug: --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG
61
+ is capable of SCSI drive hot plug (no reboot required)
62
+
63
+ disc_scsi_hot_unplug: --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG
64
+ is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.
65
+
66
+ ionoscloud_username: --username USERNAME, -u USERNAME
67
+ your Ionoscloud username (required)
68
+
69
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
70
+ your Ionoscloud password (required)
71
+
72
+ ionoscloud_url: --url URL
73
+ the Ionoscloud API URL
74
+
75
+ ```
76
+ ## Example
77
+
78
+ ```text
79
+ knife ionoscloud snapshot update --extra-config EXTRA_CONFIG_FILE_PATH --snapshot-id SNAPSHOT_ID --name NAME --description DESCRIPTION --sec-auth-protection SEC_AUTH_PROTECTION --licence-type LICENCE --cpu-hot-plug CPU_HOT_PLUG --cpu-hot-unplug CPU_HOT_UNPLUG --ram-hot-plug RAM_HOT_PLUG --ram-hot-unplug RAM_HOT_UNPLUG --nic-hot-plug NIC_HOT_PLUG --nic-hot-unplug NIC_HOT_UNPLUG --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG --username USERNAME --password PASSWORD --url URL
80
+ ```
@@ -14,18 +14,21 @@ knife ionoscloud template list
14
14
  * ionoscloud\_password
15
15
 
16
16
  ```text
17
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
18
+ path to the additional config file
19
+
17
20
  ionoscloud_username: --username USERNAME, -u USERNAME
18
21
  your Ionoscloud username (required)
19
22
 
20
23
  ionoscloud_password: --password PASSWORD, -p PASSWORD
21
24
  your Ionoscloud password (required)
22
25
 
23
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
24
- path to the additional config file
26
+ ionoscloud_url: --url URL
27
+ the Ionoscloud API URL
25
28
 
26
29
  ```
27
30
  ## Example
28
31
 
29
32
  ```text
30
- knife ionoscloud template list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud template list--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -18,13 +18,16 @@ knife ionoscloud user create (options)
18
18
  * ionoscloud\_password
19
19
 
20
20
  ```text
21
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
22
+ path to the additional config file
23
+
21
24
  firstname: --firstname FIRSTNAME, -f FIRSTNAME
22
25
  firstname of the user. (required)
23
26
 
24
27
  lastname: --lastname LASTNAME, -l LASTNAME
25
28
  lastname of the user. (required)
26
29
 
27
- email: --email EMAIL, -e EMAIL
30
+ email: --email EMAIL
28
31
  an e-mail address for the user. (required)
29
32
 
30
33
  password: --password PASSWORD, -p PASSWORD
@@ -33,21 +36,27 @@ knife ionoscloud user create (options)
33
36
  administrator: --admin ADMIN, -a ADMIN
34
37
  assigns the user have administrative rights.
35
38
 
36
- force_sec_auth: --sec-auth
39
+ force_sec_auth: --force-sec-auth
37
40
  indicates if secure (two-factor) authentication should be forced for the user.
38
41
 
42
+ sec_auth_active: --sec-auth
43
+ indicates if secure authentication is active for the user or not.
44
+
45
+ active: --active
46
+ indicates if the user is active.
47
+
39
48
  ionoscloud_username: --username USERNAME, -u USERNAME
40
49
  your Ionoscloud username (required)
41
50
 
42
51
  ionoscloud_password: --password PASSWORD, -p PASSWORD
43
52
  your Ionoscloud password (required)
44
53
 
45
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
46
- path to the additional config file
54
+ ionoscloud_url: --url URL
55
+ the Ionoscloud API URL
47
56
 
48
57
  ```
49
58
  ## Example
50
59
 
51
60
  ```text
52
- knife ionoscloud user create --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --sec-auth --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
61
+ knife ionoscloud user create --extra-config EXTRA_CONFIG_FILE_PATH --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --force-sec-auth --sec-auth --active --username USERNAME --password PASSWORD --url URL
53
62
  ```
@@ -14,18 +14,21 @@ knife ionoscloud user delete USER_ID [USER_ID]
14
14
  * ionoscloud\_password
15
15
 
16
16
  ```text
17
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
18
+ path to the additional config file
19
+
17
20
  ionoscloud_username: --username USERNAME, -u USERNAME
18
21
  your Ionoscloud username (required)
19
22
 
20
23
  ionoscloud_password: --password PASSWORD, -p PASSWORD
21
24
  your Ionoscloud password (required)
22
25
 
23
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
24
- path to the additional config file
26
+ ionoscloud_url: --url URL
27
+ the Ionoscloud API URL
25
28
 
26
29
  ```
27
30
  ## Example
28
31
 
29
32
  ```text
30
- knife ionoscloud user delete USER_ID [USER_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud user delete USER_ID [USER_ID]--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -0,0 +1,38 @@
1
+ # UserGet
2
+
3
+ Retrieves the attributes of a given Ionoscloud User.
4
+
5
+ ```text
6
+ knife ionoscloud user get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * user\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
21
+ user_id: --user-id USER_ID, -U USER_ID
22
+ iD of the group. (required)
23
+
24
+ ionoscloud_username: --username USERNAME, -u USERNAME
25
+ your Ionoscloud username (required)
26
+
27
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
28
+ your Ionoscloud password (required)
29
+
30
+ ionoscloud_url: --url URL
31
+ the Ionoscloud API URL
32
+
33
+ ```
34
+ ## Example
35
+
36
+ ```text
37
+ knife ionoscloud user get --extra-config EXTRA_CONFIG_FILE_PATH --user-id USER_ID --username USERNAME --password PASSWORD --url URL
38
+ ```
@@ -14,6 +14,9 @@ knife ionoscloud user list (options)
14
14
  * ionoscloud\_password
15
15
 
16
16
  ```text
17
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
18
+ path to the additional config file
19
+
17
20
  group_id: --group-id GROUP_ID, -g GROUP_ID
18
21
  iD of the group.
19
22
 
@@ -23,12 +26,12 @@ knife ionoscloud user list (options)
23
26
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
27
  your Ionoscloud password (required)
25
28
 
26
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
27
- path to the additional config file
29
+ ionoscloud_url: --url URL
30
+ the Ionoscloud API URL
28
31
 
29
32
  ```
30
33
  ## Example
31
34
 
32
35
  ```text
33
- knife ionoscloud user list --group-id GROUP_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
36
+ knife ionoscloud user list --extra-config EXTRA_CONFIG_FILE_PATH --group-id GROUP_ID --username USERNAME --password PASSWORD --url URL
34
37
  ```
@@ -15,6 +15,9 @@ knife ionoscloud user ssourl (options)
15
15
  * ionoscloud\_password
16
16
 
17
17
  ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
18
21
  user_id: --user-id USER_ID, -U USER_ID
19
22
  the ID of the Backup unit. (required)
20
23
 
@@ -24,12 +27,12 @@ knife ionoscloud user ssourl (options)
24
27
  ionoscloud_password: --password PASSWORD, -p PASSWORD
25
28
  your Ionoscloud password (required)
26
29
 
27
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
28
- path to the additional config file
30
+ ionoscloud_url: --url URL
31
+ the Ionoscloud API URL
29
32
 
30
33
  ```
31
34
  ## Example
32
35
 
33
36
  ```text
34
- knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
37
+ knife ionoscloud user ssourl --extra-config EXTRA_CONFIG_FILE_PATH --user-id USER_ID --username USERNAME --password PASSWORD --url URL
35
38
  ```
@@ -0,0 +1,59 @@
1
+ # UserUpdate
2
+
3
+ Updates information about a Ionoscloud User.
4
+
5
+ ```text
6
+ knife ionoscloud user update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * user\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
21
+ user_id: --user-id USER_ID, -U USER_ID
22
+ iD of the User. (required)
23
+
24
+ firstname: --firstname FIRSTNAME, -f FIRSTNAME
25
+ firstname of the user.
26
+
27
+ lastname: --lastname LASTNAME, -l LASTNAME
28
+ lastname of the user.
29
+
30
+ email: --email EMAIL
31
+ an e-mail address for the user.
32
+
33
+ administrator: --admin ADMIN, -a ADMIN
34
+ assigns the user have administrative rights.
35
+
36
+ force_sec_auth: --sec-auth FORCE_SEC_AUTH
37
+ indicates if secure (two-factor) authentication should be forced for the user.
38
+
39
+ sec_auth_active: --sec-auth SEC_AUTH_ACTIVE
40
+ indicates if secure authentication is active for the user or not.
41
+
42
+ active: --active ACTIVE
43
+ indicates if the user is active.
44
+
45
+ ionoscloud_username: --username USERNAME, -u USERNAME
46
+ your Ionoscloud username (required)
47
+
48
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
49
+ your Ionoscloud password (required)
50
+
51
+ ionoscloud_url: --url URL
52
+ the Ionoscloud API URL
53
+
54
+ ```
55
+ ## Example
56
+
57
+ ```text
58
+ knife ionoscloud user update --extra-config EXTRA_CONFIG_FILE_PATH --user-id USER_ID --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --admin ADMIN --sec-auth FORCE_SEC_AUTH --sec-auth SEC_AUTH_ACTIVE --active ACTIVE --username USERNAME --password PASSWORD --url URL
59
+ ```
@@ -16,6 +16,9 @@ knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
16
16
  * ionoscloud\_password
17
17
 
18
18
  ```text
19
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
20
+ path to the additional config file
21
+
19
22
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
20
23
  the ID of the data center (required)
21
24
 
@@ -28,8 +31,8 @@ knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
28
31
  ionoscloud_password: --password PASSWORD, -p PASSWORD
29
32
  your Ionoscloud password (required)
30
33
 
31
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
32
- path to the additional config file
34
+ ionoscloud_url: --url URL
35
+ the Ionoscloud API URL
33
36
 
34
37
  ```
35
38
  ## Example
@@ -18,6 +18,9 @@ knife ionoscloud volume create (options)
18
18
  * ionoscloud\_password
19
19
 
20
20
  ```text
21
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
22
+ path to the additional config file
23
+
21
24
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
22
25
  name of the data center (required)
23
26
 
@@ -33,11 +36,14 @@ knife ionoscloud volume create (options)
33
36
  image: --image ID, -N ID
34
37
  the image or snapshot ID
35
38
 
39
+ image_alias: --image-alias IMAGE_ALIAS
40
+ (required) The image alias
41
+
36
42
  image_password: --image-password PASSWORD, -P PASSWORD
37
43
  the password set on the image for the "root" or "Administrator" user
38
44
 
39
45
  type: --type TYPE, -t TYPE
40
- the disk type (HDD, SSD, SSD Standard, SSD Premium, DAS) (required)
46
+ the disk type (HDD OR SSD) (required)
41
47
 
42
48
  licence_type: --licence-type LICENCE, -l LICENCE
43
49
  the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
@@ -54,18 +60,36 @@ knife ionoscloud volume create (options)
54
60
  user_data: --user-data USER_DATA, -u USER_DATA
55
61
  the cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property.
56
62
 
63
+ cpu_hot_plug: --cpu-hot-plug CPU_HOT_PLUG
64
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
65
+
66
+ ram_hot_plug: --ram-hot-plug RAM_HOT_PLUG
67
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
68
+
69
+ nic_hot_plug: --nic-hot-plug NIC_HOT_PLUG
70
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
71
+
72
+ nic_hot_unplug: --nic-hot-unplug NIC_HOT_UNPLUG
73
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
74
+
75
+ disc_virtio_hot_plug: --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG
76
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
77
+
78
+ disc_virtio_hot_unplug: --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG
79
+ the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
80
+
57
81
  ionoscloud_username: --username USERNAME, -u USERNAME
58
82
  your Ionoscloud username (required)
59
83
 
60
84
  ionoscloud_password: --password PASSWORD, -p PASSWORD
61
85
  your Ionoscloud password (required)
62
86
 
63
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
64
- path to the additional config file
87
+ ionoscloud_url: --url URL
88
+ the Ionoscloud API URL
65
89
 
66
90
  ```
67
91
  ## Example
68
92
 
69
93
  ```text
70
- knife ionoscloud volume create --datacenter-id DATACENTER_ID --name NAME --size SIZE --bus BUS --image ID --image-password PASSWORD --type TYPE --licence-type LICENCE --ssh-keys SSHKEY1,SSHKEY2,... --availability-zone AVAILABILITY_ZONE --backupunit BACKUPUNIT_ID --user-data USER_DATA --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
94
+ knife ionoscloud volume create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --size SIZE --bus BUS --image ID --image-alias IMAGE_ALIAS --image-password PASSWORD --type TYPE --licence-type LICENCE --ssh-keys SSHKEY1,SSHKEY2,... --availability-zone AVAILABILITY_ZONE --backupunit BACKUPUNIT_ID --user-data USER_DATA --cpu-hot-plug CPU_HOT_PLUG --ram-hot-plug RAM_HOT_PLUG --nic-hot-plug NIC_HOT_PLUG --nic-hot-unplug NIC_HOT_UNPLUG --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG --username USERNAME --password PASSWORD --url URL
71
95
  ```
@@ -15,6 +15,9 @@ knife ionoscloud volume delete SERVER_ID [SERVER_ID] (options)
15
15
  * ionoscloud\_password
16
16
 
17
17
  ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
18
21
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
22
  name of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud volume delete SERVER_ID [SERVER_ID] (options)
24
27
  ionoscloud_password: --password PASSWORD, -p PASSWORD
25
28
  your Ionoscloud password (required)
26
29
 
27
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
28
- path to the additional config file
30
+ ionoscloud_url: --url URL
31
+ the Ionoscloud API URL
29
32
 
30
33
  ```
31
34
  ## Example
@@ -18,6 +18,9 @@ knife ionoscloud volume detach VOLUME_ID [VOLUME_ID] (options)
18
18
  * ionoscloud\_password
19
19
 
20
20
  ```text
21
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
22
+ path to the additional config file
23
+
21
24
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
22
25
  the ID of the data center (required)
23
26
 
@@ -30,8 +33,8 @@ knife ionoscloud volume detach VOLUME_ID [VOLUME_ID] (options)
30
33
  ionoscloud_password: --password PASSWORD, -p PASSWORD
31
34
  your Ionoscloud password (required)
32
35
 
33
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
34
- path to the additional config file
36
+ ionoscloud_url: --url URL
37
+ the Ionoscloud API URL
35
38
 
36
39
  ```
37
40
  ## Example
@@ -0,0 +1,42 @@
1
+ # VolumeGet
2
+
3
+ Retrieves the attributes of a given Volume.
4
+
5
+ ```text
6
+ knife ionoscloud volume get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * datacenter\_id
14
+ * volume\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
19
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
20
+ path to the additional config file
21
+
22
+ datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
23
+ iD of the data center (required)
24
+
25
+ volume_id: --volume VOLUME_ID
26
+ iD of the volume. (required)
27
+
28
+ ionoscloud_username: --username USERNAME, -u USERNAME
29
+ your Ionoscloud username (required)
30
+
31
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
32
+ your Ionoscloud password (required)
33
+
34
+ ionoscloud_url: --url URL
35
+ the Ionoscloud API URL
36
+
37
+ ```
38
+ ## Example
39
+
40
+ ```text
41
+ knife ionoscloud volume get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD --url URL
42
+ ```
@@ -15,6 +15,9 @@ knife ionoscloud volume list (options)
15
15
  * ionoscloud\_password
16
16
 
17
17
  ```text
18
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
19
+ path to the additional config file
20
+
18
21
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
22
  the ID of the virtul data center containing the volume (required)
20
23
 
@@ -27,12 +30,12 @@ knife ionoscloud volume list (options)
27
30
  ionoscloud_password: --password PASSWORD, -p PASSWORD
28
31
  your Ionoscloud password (required)
29
32
 
30
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
31
- path to the additional config file
33
+ ionoscloud_url: --url URL
34
+ the Ionoscloud API URL
32
35
 
33
36
  ```
34
37
  ## Example
35
38
 
36
39
  ```text
37
- knife ionoscloud volume list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
40
+ knife ionoscloud volume list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
38
41
  ```