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
data/docs/subcommands/s3key_list.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud s3key 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
  user_id: --user USER_ID, -u USER_ID
19
22
  the ID of the user (required)
20
23
 
@@ -24,12 +27,12 @@ knife ionoscloud s3key list (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 s3key list --user USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
37
+ knife ionoscloud s3key list --extra-config EXTRA_CONFIG_FILE_PATH --user USER_ID --username USERNAME --password PASSWORD --url URL
35
38
  ```
data/docs/subcommands/server_console.md CHANGED
@@ -16,6 +16,9 @@ knife ionoscloud server console (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 Datacenter. (required)
21
24
 
@@ -28,12 +31,12 @@ knife ionoscloud server console (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
36
39
 
37
40
  ```text
38
- knife ionoscloud server console --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
41
+ knife ionoscloud server console --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
39
42
  ```
data/docs/subcommands/server_create.md CHANGED
@@ -19,6 +19,9 @@ knife ionoscloud server create (options)
19
19
  * ionoscloud\_password
20
20
 
21
21
  ```text
22
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
23
+ path to the additional config file
24
+
22
25
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
23
26
  name of the virtual datacenter (required)
24
27
 
@@ -49,12 +52,12 @@ knife ionoscloud server create (options)
49
52
  ionoscloud_password: --password PASSWORD, -p PASSWORD
50
53
  your Ionoscloud password (required)
51
54
 
52
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
53
- path to the additional config file
55
+ ionoscloud_url: --url URL
56
+ the Ionoscloud API URL
54
57
 
55
58
  ```
56
59
  ## Example
57
60
 
58
61
  ```text
59
- knife ionoscloud server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
62
+ knife ionoscloud server create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD --url URL
60
63
  ```
data/docs/subcommands/server_delete.md CHANGED
@@ -17,6 +17,9 @@ knife ionoscloud server delete SERVER_ID [SERVER_ID] (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-id DATACENTER_ID, -D DATACENTER_ID
21
24
  name of the data center (required)
22
25
 
@@ -26,8 +29,8 @@ knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
26
29
  ionoscloud_password: --password PASSWORD, -p PASSWORD
27
30
  your Ionoscloud password (required)
28
31
 
29
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
30
- path to the additional config file
32
+ ionoscloud_url: --url URL
33
+ the Ionoscloud API URL
31
34
 
32
35
  ```
33
36
  ## Example
data/docs/subcommands/server_get.md ADDED
@@ -0,0 +1,42 @@
1
+ # ServerGet
2
+
3
+ Retrieves the attributes of a given Server.
4
+
5
+ ```text
6
+ knife ionoscloud server get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * datacenter\_id
14
+ * server\_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
+ server_id: --server-id SERVER_ID, -S SERVER_ID
26
+ the ID of the server to which the NIC is assigned (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 server get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
42
+ ```
data/docs/subcommands/server_list.md CHANGED
@@ -15,24 +15,24 @@ knife ionoscloud server 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 datacenter containing the server (required)
20
23
 
21
- upgrade_needed: --upgrade-needed, -u
22
- it can be used to filter which servers can be upgraded
23
-
24
24
  ionoscloud_username: --username USERNAME, -u USERNAME
25
25
  your Ionoscloud username (required)
26
26
 
27
27
  ionoscloud_password: --password PASSWORD, -p PASSWORD
28
28
  your Ionoscloud password (required)
29
29
 
30
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
31
- path to the additional config file
30
+ ionoscloud_url: --url URL
31
+ the Ionoscloud API URL
32
32
 
33
33
  ```
34
34
  ## Example
35
35
 
36
36
  ```text
37
- knife ionoscloud server list --datacenter-id DATACENTER_ID --upgrade-needed --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
37
+ knife ionoscloud server list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --url URL
38
38
  ```
data/docs/subcommands/server_reboot.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud server reboot 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
  iD of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud server reboot 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
data/docs/subcommands/server_resume.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud server resume 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
  iD of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud server resume 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
data/docs/subcommands/server_start.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud server start 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
  iD of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud server start 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
data/docs/subcommands/server_stop.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud server stop 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
  iD of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud server stop 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
data/docs/subcommands/server_suspend.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud server suspend 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
  iD of the data center (required)
20
23
 
@@ -24,8 +27,8 @@ knife ionoscloud server suspend 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
data/docs/subcommands/server_token.md CHANGED
@@ -16,6 +16,9 @@ knife ionoscloud server token (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 Datacenter. (required)
21
24
 
@@ -28,12 +31,12 @@ knife ionoscloud server token (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
36
39
 
37
40
  ```text
38
- knife ionoscloud server token --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
41
+ knife ionoscloud server token --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
39
42
  ```
data/docs/subcommands/server_update.md ADDED
@@ -0,0 +1,63 @@
1
+ # ServerUpdate
2
+
3
+ Updates information about a Ionoscloud Server.
4
+
5
+ ```text
6
+ knife ionoscloud server update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * datacenter\_id
14
+ * server\_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
+ server_id: --server-id SERVER_ID, -S SERVER_ID
26
+ the ID of the server to which the NIC is assigned (required)
27
+
28
+ name: --name NAME, -n NAME
29
+ name of the server
30
+
31
+ cores: --cores CORES, -C CORES
32
+ the number of processor cores
33
+
34
+ cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
35
+ the family of the CPU (INTEL_XEON or AMD_OPTERON)
36
+
37
+ ram: --ram RAM, -r RAM
38
+ the amount of RAM in MB
39
+
40
+ availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
41
+ the availability zone of the server
42
+
43
+ boot_volume: --boot-volume VOLUME_ID
44
+ reference to a volume used for booting
45
+
46
+ boot_cdrom: --boot-cdrom CDROM_ID
47
+ reference to a CD-ROM used for booting
48
+
49
+ ionoscloud_username: --username USERNAME, -u USERNAME
50
+ your Ionoscloud username (required)
51
+
52
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
53
+ your Ionoscloud password (required)
54
+
55
+ ionoscloud_url: --url URL
56
+ the Ionoscloud API URL
57
+
58
+ ```
59
+ ## Example
60
+
61
+ ```text
62
+ knife ionoscloud server update --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD --url URL
63
+ ```
data/docs/subcommands/server_upgrade.md CHANGED
@@ -16,6 +16,9 @@ knife ionoscloud server upgrade (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 Datacenter. (required)
21
24
 
@@ -28,12 +31,12 @@ knife ionoscloud server upgrade (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
36
39
 
37
40
  ```text
38
- knife ionoscloud server upgrade --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
41
+ knife ionoscloud server upgrade --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
39
42
  ```
data/docs/subcommands/share_create.md CHANGED
@@ -16,13 +16,16 @@ knife ionoscloud share create (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
  group_id: --group-id GROUP_ID, -G GROUP_ID
20
23
  iD of the group. (required)
21
24
 
22
25
  resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
23
26
  the ID of the resource. (required)
24
27
 
25
- edit_privilege: --edit, -e
28
+ edit_privilege: --edit
26
29
  the group has permission to edit privileges on this resource.
27
30
 
28
31
  share_privilege: --share, -s
@@ -34,12 +37,12 @@ knife ionoscloud share create (options)
34
37
  ionoscloud_password: --password PASSWORD, -p PASSWORD
35
38
  your Ionoscloud password (required)
36
39
 
37
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
38
- path to the additional config file
40
+ ionoscloud_url: --url URL
41
+ the Ionoscloud API URL
39
42
 
40
43
  ```
41
44
  ## Example
42
45
 
43
46
  ```text
44
- knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
47
+ knife ionoscloud share create --extra-config EXTRA_CONFIG_FILE_PATH --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD --url URL
45
48
  ```
data/docs/subcommands/share_delete.md CHANGED
@@ -3,7 +3,7 @@
3
3
  Removes a resource share from a specified group.
4
4
 
5
5
  ```text
6
- knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
6
+ knife ionoscloud server delete RESOURCE_ID [RESOURCE_ID] (options)
7
7
  ```
8
8
 
9
9
  ## Available options:
@@ -15,6 +15,9 @@ knife ionoscloud server delete SHARE_ID [SHARE_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
  group_id: --group-id GROUP_ID, -G GROUP_ID
19
22
  iD of the group. (required)
20
23
 
@@ -24,12 +27,12 @@ knife ionoscloud server delete SHARE_ID [SHARE_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
32
35
 
33
36
  ```text
34
- knife ionoscloud server delete SHARE_ID
37
+ knife ionoscloud server delete RESOURCE_ID
35
38
  ```
data/docs/subcommands/share_get.md ADDED
@@ -0,0 +1,42 @@
1
+ # ShareGet
2
+
3
+ Retrieves the attributes of a given Group Share.
4
+
5
+ ```text
6
+ knife ionoscloud share get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * group\_id
14
+ * resource\_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
+ group_id: --group-id GROUP_ID, -G GROUP_ID
23
+ iD of the group. (required)
24
+
25
+ resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
26
+ the ID of the resource. (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 share get --extra-config EXTRA_CONFIG_FILE_PATH --group-id GROUP_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --url URL
42
+ ```
data/docs/subcommands/share_list.md CHANGED
@@ -15,6 +15,9 @@ knife ionoscloud share 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
  group_id: --group-id GROUP_ID, -G GROUP_ID
19
22
  iD of the group. (required)
20
23
 
@@ -24,12 +27,12 @@ knife ionoscloud share list (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 share list --group-id GROUP_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
37
+ knife ionoscloud share list --extra-config EXTRA_CONFIG_FILE_PATH --group-id GROUP_ID --username USERNAME --password PASSWORD --url URL
35
38
  ```
data/docs/subcommands/share_update.md ADDED
@@ -0,0 +1,48 @@
1
+ # ShareUpdate
2
+
3
+ Updates information about a Ionoscloud Group Share.
4
+
5
+ ```text
6
+ knife ionoscloud share update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * group\_id
14
+ * resource\_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
+ group_id: --group-id GROUP_ID, -G GROUP_ID
23
+ iD of the group. (required)
24
+
25
+ resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
26
+ the ID of the resource. (required)
27
+
28
+ edit_privilege: --edit EDIT_PRIVILEGE
29
+ the group has permission to edit privileges on this resource.
30
+
31
+ share_privilege: --share SHARE_PRIVILEGE, -s SHARE_PRIVILEGE
32
+ the group has permission to share this resource.
33
+
34
+ ionoscloud_username: --username USERNAME, -u USERNAME
35
+ your Ionoscloud username (required)
36
+
37
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
38
+ your Ionoscloud password (required)
39
+
40
+ ionoscloud_url: --url URL
41
+ the Ionoscloud API URL
42
+
43
+ ```
44
+ ## Example
45
+
46
+ ```text
47
+ knife ionoscloud share update --extra-config EXTRA_CONFIG_FILE_PATH --group-id GROUP_ID --resource-id RESOURCE_ID --edit EDIT_PRIVILEGE --share SHARE_PRIVILEGE --username USERNAME --password PASSWORD --url URL
48
+ ```
data/docs/subcommands/snapshot_create.md CHANGED
@@ -16,6 +16,9 @@ knife ionoscloud snapshot create (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 DATACENTER_ID, -D DATACENTER_ID
20
23
  iD of the Datacenter (required)
21
24
 
@@ -40,12 +43,12 @@ knife ionoscloud snapshot create (options)
40
43
  ionoscloud_password: --password PASSWORD, -p PASSWORD
41
44
  your Ionoscloud password (required)
42
45
 
43
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
44
- path to the additional config file
46
+ ionoscloud_url: --url URL
47
+ the Ionoscloud API URL
45
48
 
46
49
  ```
47
50
  ## Example
48
51
 
49
52
  ```text
50
- knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --name SNAPSHOT_NAME --description SNAPSHOT_DESCRIPTION --sec-auth --licence LICENCE_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
53
+ knife ionoscloud snapshot create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter DATACENTER_ID --volume VOLUME_ID --name SNAPSHOT_NAME --description SNAPSHOT_DESCRIPTION --sec-auth --licence LICENCE_TYPE --username USERNAME --password PASSWORD --url URL
51
54
  ```
data/docs/subcommands/snapshot_delete.md CHANGED
@@ -14,18 +14,21 @@ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_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 snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```