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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7eb585be2cb294b884a7a37fa48edfc54998716ffcbce169898372eb9e24f143
4
- data.tar.gz: 95ea0e6e4ab11d865c63537b6dd63bef204197e1a32610a3c7208018c8c7f8a1
3
+ metadata.gz: e01979765cd8e47bdb767d5526e440eee9237c3a61060f0f5baf451e5dbcb9fa
4
+ data.tar.gz: def67d397e54a9dfe79fdbf4e1a5537022ba82108c119d6f922b0fe184d722b4
5
5
  SHA512:
6
- metadata.gz: dd0ee5ff7332cfb3004000b7d8f422bf370d4e0d06c0c4185144fb83d790b123d3479f3cf1886cbd2f5eb4a9c78d3baed152f6941db3687c47e3825400bdbed0
7
- data.tar.gz: d1b0da891bea8cf664277a8d298cefbc1d42c08b698d9c7810011346b92f437526104049c0926535c083c0883836af6c18989bf2472b30f36ceb3e4a5d9aafc8
6
+ metadata.gz: 37512cd2d43d178c00d561bd5195401e2f9f36bb6949a4f6e0c755c7212415b3ce3318a479e095834310b17b8fb7a0441e891fbfc7d7c6e9ff42a3f9f50e4443
7
+ data.tar.gz: 8cab82713670696934ecc997d72e134ca2f85692b35e25a0f60c9bab2020db5fa3d7a4e075ed6b53828fed8d194c7d84efcd38ce0b234ddfd934a98fd5738125
data/docs/README.md CHANGED
@@ -87,6 +87,17 @@ When using the command `knife ionoscloud datacenter create --extra-config EXTRA_
87
87
  * Only Ionoscloud specific options may be altered using this option.
88
88
  * If an option is ignored because it is not on the available options list or if it is overwritten in another way then a warning message will be displayed.
89
89
 
90
+ ### Changing the API url
91
+
92
+ By changing API url the module will make all calls using the provided url. To change the API url used by the knife module, one can do either of the following:
93
+ * specify the new url using `--url NEW_URL`
94
+ * set it in a json file, using the `ionoscloud_url` key, and passing the file to the command like described in the section above
95
+ * set the new url in the knife.rb file. It could be set using an environmental variable, same as with the username and the password.
96
+
97
+ ```text
98
+ knife[:ionoscloud_url] = NEW_API_URL
99
+ ```
100
+
90
101
  ## Feature Reference
91
102
 
92
103
  The IONOS Cloud plugin for Knife aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:
@@ -17,13 +17,16 @@ knife ionoscloud backupunit create (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
  name: --name NAME, -n NAME
21
24
  alphanumeric name you want assigned to the backup unit (required)
22
25
 
23
26
  password: --password PASSWORD, -p PASSWORD
24
27
  alphanumeric password you want assigned to the backup unit (required)
25
28
 
26
- email: --email EMAIL, -e EMAIL
29
+ email: --email EMAIL
27
30
  the e-mail address you want assigned to the backup unit. (required)
28
31
 
29
32
  ionoscloud_username: --username USERNAME, -u USERNAME
@@ -32,12 +35,12 @@ knife ionoscloud backupunit create (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 backupunit create --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
45
+ knife ionoscloud backupunit create --extra-config EXTRA_CONFIG_FILE_PATH --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD --url URL
43
46
  ```
@@ -14,18 +14,21 @@ knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_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 backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -0,0 +1,38 @@
1
+ # BackupunitGet
2
+
3
+ Retrieves information about a backup unit.
4
+
5
+ ```text
6
+ knife ionoscloud backupunit get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * backupunit\_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
+ backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
22
+ the ID of the Backup unit. (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 backupunit get --extra-config EXTRA_CONFIG_FILE_PATH --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD --url URL
38
+ ```
@@ -14,18 +14,21 @@ knife ionoscloud backupunit 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 backupunit list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud backupunit list--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -15,6 +15,9 @@ knife ionoscloud backupunit 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
  backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
19
22
  the ID of the Backup unit. (required)
20
23
 
@@ -24,12 +27,12 @@ knife ionoscloud backupunit 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 backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
37
+ knife ionoscloud backupunit ssourl --extra-config EXTRA_CONFIG_FILE_PATH --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD --url URL
35
38
  ```
@@ -0,0 +1,44 @@
1
+ # BackupunitUpdate
2
+
3
+ Retrieves information about a backup unit.
4
+
5
+ ```text
6
+ knife ionoscloud backupunit update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * backupunit\_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
+ backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
22
+ the ID of the Backup unit. (required)
23
+
24
+ password: --password PASSWORD, -p PASSWORD
25
+ alphanumeric password you want assigned to the backup unit
26
+
27
+ email: --email EMAIL
28
+ the e-mail address you want assigned to the backup unit.
29
+
30
+ ionoscloud_username: --username USERNAME, -u USERNAME
31
+ your Ionoscloud username (required)
32
+
33
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
34
+ your Ionoscloud password (required)
35
+
36
+ ionoscloud_url: --url URL
37
+ the Ionoscloud API URL
38
+
39
+ ```
40
+ ## Example
41
+
42
+ ```text
43
+ knife ionoscloud backupunit update --extra-config EXTRA_CONFIG_FILE_PATH --backupunit-id BACKUPUNIT_ID --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD --url URL
44
+ ```
@@ -22,6 +22,9 @@ knife ionoscloud composite server create (options)
22
22
  * ionoscloud\_password
23
23
 
24
24
  ```text
25
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
26
+ path to the additional config file
27
+
25
28
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
26
29
  name of the virtual datacenter (required)
27
30
 
@@ -70,12 +73,6 @@ knife ionoscloud composite server create (options)
70
73
  ssh_keys: --ssh-keys SSHKEY1,SSHKEY2,..., -K SSHKEY[,SSHKEY,...]
71
74
  a list of public SSH keys to include
72
75
 
73
- backupunit_id: --backupunit BACKUPUNIT_ID, -B BACKUPUNIT_ID
74
- the uuid of the Backup Unit that user has access to. 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' in conjunction with this property.
75
-
76
- user_data: --user-data USER_DATA, -u USER_DATA
77
- 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.
78
-
79
76
  nic_name: --nic-name NAME
80
77
  name of the NIC
81
78
 
@@ -88,8 +85,8 @@ knife ionoscloud composite server create (options)
88
85
  lan: --lan ID, -L ID
89
86
  the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created (required)
90
87
 
91
- firewall_type: --firewall-type FIREWALL_TYPE
92
- the type of firewall rules that will be allowed on the NIC. If it is not specified it will take the default value INGRESS
88
+ nat: --nat
89
+ set to enable NAT on the NIC
93
90
 
94
91
  ionoscloud_username: --username USERNAME, -u USERNAME
95
92
  your Ionoscloud username (required)
@@ -97,12 +94,12 @@ knife ionoscloud composite server create (options)
97
94
  ionoscloud_password: --password PASSWORD, -p PASSWORD
98
95
  your Ionoscloud password (required)
99
96
 
100
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
101
- path to the additional config file
97
+ ionoscloud_url: --url URL
98
+ the Ionoscloud API URL
102
99
 
103
100
  ```
104
101
  ## Example
105
102
 
106
103
  ```text
107
- knife ionoscloud composite server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --volume-name NAME --size SIZE --bus BUS --image ID --image-alias IMAGE_ALIAS --type TYPE --licence-type LICENCE --image-password PASSWORD --volume-availability-zone AVAILABILITY_ZONE --ssh-keys SSHKEY1,SSHKEY2,... --backupunit BACKUPUNIT_ID --user-data USER_DATA --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
104
+ knife ionoscloud composite 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 --volume-name NAME --size SIZE --bus BUS --image ID --image-alias IMAGE_ALIAS --type TYPE --licence-type LICENCE --image-password PASSWORD --volume-availability-zone AVAILABILITY_ZONE --ssh-keys SSHKEY1,SSHKEY2,... --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD --url URL
108
105
  ```
@@ -14,18 +14,21 @@ knife ionoscloud contract 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 contract list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud contract list--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -17,6 +17,9 @@ knife ionoscloud cube server create (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 virtual datacenter (required)
22
25
 
@@ -80,12 +83,12 @@ knife ionoscloud cube server create (options)
80
83
  ionoscloud_password: --password PASSWORD, -p PASSWORD
81
84
  your Ionoscloud password (required)
82
85
 
83
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
84
- path to the additional config file
86
+ ionoscloud_url: --url URL
87
+ the Ionoscloud API URL
85
88
 
86
89
  ```
87
90
  ## Example
88
91
 
89
92
  ```text
90
- knife ionoscloud cube server create --datacenter-id DATACENTER_ID --name NAME --template TEMPLATE_UUID --cpu-family CPU_FAMILY --availability-zone AVAILABILITY_ZONE --volume-name NAME --bus BUS --image ID --licence-type LICENCE --image-password PASSWORD --ssh-keys SSHKEY1,SSHKEY2,... --backupunit BACKUPUNIT_ID --user-data USER_DATA --set-boot --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
93
+ knife ionoscloud cube server create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --template TEMPLATE_UUID --cpu-family CPU_FAMILY --availability-zone AVAILABILITY_ZONE --volume-name NAME --bus BUS --image ID --licence-type LICENCE --image-password PASSWORD --ssh-keys SSHKEY1,SSHKEY2,... --backupunit BACKUPUNIT_ID --user-data USER_DATA --set-boot --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --url URL
91
94
  ```
@@ -22,6 +22,9 @@ knife ionoscloud datacenter create (options)
22
22
  * ionoscloud\_password
23
23
 
24
24
  ```text
25
+ extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
26
+ path to the additional config file
27
+
25
28
  name: --name NAME, -n NAME
26
29
  name of the data center
27
30
 
@@ -37,12 +40,12 @@ knife ionoscloud datacenter create (options)
37
40
  ionoscloud_password: --password PASSWORD, -p PASSWORD
38
41
  your Ionoscloud password (required)
39
42
 
40
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
41
- path to the additional config file
43
+ ionoscloud_url: --url URL
44
+ the Ionoscloud API URL
42
45
 
43
46
  ```
44
47
  ## Example
45
48
 
46
49
  ```text
47
- knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
50
+ knife ionoscloud datacenter create --extra-config EXTRA_CONFIG_FILE_PATH --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD --url URL
48
51
  ```
@@ -14,18 +14,21 @@ knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_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 datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -0,0 +1,38 @@
1
+ # DatacenterGet
2
+
3
+ Retrieves information about a Ionoscloud Datacenter.
4
+
5
+ ```text
6
+ knife ionoscloud datacenter get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * datacenter\_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
+ datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
22
+ iD of the data center (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 datacenter get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --url URL
38
+ ```
@@ -14,18 +14,21 @@ knife ionoscloud datacenter 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 datacenter list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
33
+ knife ionoscloud datacenter list--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
31
34
  ```
@@ -0,0 +1,47 @@
1
+ # DatacenterUpdate
2
+
3
+ Updates information about a Ionoscloud Datacenter.
4
+
5
+ ```text
6
+ knife ionoscloud datacenter update (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * datacenter\_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
+ datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
22
+ iD of the data center (required)
23
+
24
+ name: --name NAME, -n NAME
25
+ name of the data center
26
+
27
+ description: --description DESCRIPTION
28
+ description of the data center
29
+
30
+ sec_auth_protection: --sec-auth-protection SEC_AUTH_PROTECTION
31
+ boolean value representing if the data center requires extra protection e.g. two factor protection
32
+
33
+ ionoscloud_username: --username USERNAME, -u USERNAME
34
+ your Ionoscloud username (required)
35
+
36
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
37
+ your Ionoscloud password (required)
38
+
39
+ ionoscloud_url: --url URL
40
+ the Ionoscloud API URL
41
+
42
+ ```
43
+ ## Example
44
+
45
+ ```text
46
+ knife ionoscloud datacenter update --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --description DESCRIPTION --sec-auth-protection SEC_AUTH_PROTECTION --username USERNAME --password PASSWORD --url URL
47
+ ```
@@ -17,6 +17,9 @@ knife ionoscloud firewall create (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
  iD of the data center (required)
22
25
 
@@ -27,7 +30,7 @@ knife ionoscloud firewall create (options)
27
30
  iD of the NIC (required)
28
31
 
29
32
  name: --name NAME, -n NAME
30
- name of the NIC
33
+ name of the Firewall Rule
31
34
 
32
35
  protocol: --protocol PROTOCOL, -P PROTOCOL
33
36
  the protocol of the firewall rule (TCP, UDP, ICMP, ANY)
@@ -44,7 +47,7 @@ knife ionoscloud firewall create (options)
44
47
  port_range_start: --port-range-start PORT, -p PORT
45
48
  defines the start range of the allowed port(s)
46
49
 
47
- port_range_end: --port-range-end PORT
50
+ port_range_end: --port-range-end PORT, -t PORT
48
51
  defines the end range of the allowed port(s)
49
52
 
50
53
  icmp_type: --icmp-type INT
@@ -53,21 +56,18 @@ knife ionoscloud firewall create (options)
53
56
  icmp_code: --icmp-code INT
54
57
  defines the allowed code (from 0 to 254) if the protocol ICMP is chosen; null allows all codes
55
58
 
56
- type: --type TYPE, --t TYPE
57
- the type of firewall rule. If is not specified, it will take the default value INGRESS
58
-
59
59
  ionoscloud_username: --username USERNAME, -u USERNAME
60
60
  your Ionoscloud username (required)
61
61
 
62
62
  ionoscloud_password: --password PASSWORD, -p PASSWORD
63
63
  your Ionoscloud password (required)
64
64
 
65
- extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
66
- path to the additional config file
65
+ ionoscloud_url: --url URL
66
+ the Ionoscloud API URL
67
67
 
68
68
  ```
69
69
  ## Example
70
70
 
71
71
  ```text
72
- knife ionoscloud firewall create --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --type TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
72
+ knife ionoscloud firewall create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD --url URL
73
73
  ```
@@ -17,6 +17,9 @@ knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_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
  the ID of the data center (required)
22
25
 
@@ -32,8 +35,8 @@ knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (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
@@ -0,0 +1,50 @@
1
+ # FirewallGet
2
+
3
+ Retrieves information about a Ionoscloud Firewall Rule.
4
+
5
+ ```text
6
+ knife ionoscloud firewall get (options)
7
+ ```
8
+
9
+ ## Available options:
10
+
11
+ ### Required options:
12
+
13
+ * firewall\_id
14
+ * datacenter\_id
15
+ * server\_id
16
+ * nic\_id
17
+ * ionoscloud\_username
18
+ * ionoscloud\_password
19
+
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
+
24
+ datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
25
+ the ID of the data center (required)
26
+
27
+ server_id: --server-id SERVER_ID, -S SERVER_ID
28
+ the ID of the server (required)
29
+
30
+ nic_id: --nic-id NIC_ID, -N NIC_ID
31
+ iD of the NIC (required)
32
+
33
+ firewall_id: --firewall-id FIREWALL_ID, -F FIREWALL_ID
34
+ iD of the Firewall Rule (required)
35
+
36
+ ionoscloud_username: --username USERNAME, -u USERNAME
37
+ your Ionoscloud username (required)
38
+
39
+ ionoscloud_password: --password PASSWORD, -p PASSWORD
40
+ your Ionoscloud password (required)
41
+
42
+ ionoscloud_url: --url URL
43
+ the Ionoscloud API URL
44
+
45
+ ```
46
+ ## Example
47
+
48
+ ```text
49
+ knife ionoscloud firewall get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --firewall-id FIREWALL_ID --username USERNAME --password PASSWORD --url URL
50
+ ```
@@ -17,6 +17,9 @@ knife ionoscloud firewall list (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
  iD of the data center (required)
22
25
 
@@ -32,12 +35,12 @@ knife ionoscloud firewall list (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 firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
45
+ knife ionoscloud firewall list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD --url URL
43
46
  ```