knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/s3key_delete.md

@@ -2,18 +2,19 @@
 
 This operation deletes a specific S3 key.
 
-    knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
-
+```text
+knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* user_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     user_id: --user USER_ID, -u USER_ID
         the ID of the user (required)
 
@@ -23,8 +24,12 @@ This operation deletes a specific S3 key.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud s3key delete S3KEY_ID 
+```text
+knife ionoscloud s3key delete S3KEY_ID 
+```

data/docs/subcommands/s3key_get.md

@@ -0,0 +1,39 @@
+# S3keyGet
+
+Retrieves the properties of an S3 Key.
+
+```text
+knife ionoscloud s3key get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* user\_id
+* s3\_key\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    user_id: --user USER_ID, -u USER_ID
+        the ID of the user (required)
+
+    s3_key_id: --s3-key S3KEY_ID, -S S3KEY_ID
+        the ID of the S3 Key. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud s3key get --user USER_ID --s3-key S3KEY_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/s3key_list.md

@@ -2,18 +2,19 @@
 
 Retrieve a list of all the S3 keys for a specific user.
 
-    knife ionoscloud s3key list (options)
-
+```text
+knife ionoscloud s3key list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* user_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     user_id: --user USER_ID, -u USER_ID
         the ID of the user (required)
 
@@ -23,8 +24,12 @@ Retrieve a list of all the S3 keys for a specific user.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/server_create.md

@@ -2,22 +2,23 @@
 
 One of the unique features of the Ionoscloud platform when compared with the other providers is that they allow you to define your own settings for cores, memory, and disk size without being tied to a particular size or flavor.
 
-Note: *The memory parameter value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so forth.*
-
-    knife ionoscloud server create (options)
+Note: _The memory parameter value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so forth._
 
+```text
+knife ionoscloud server create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
+
+* datacenter\_id
 * cores
 * ram
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the virtual datacenter (required)
 
@@ -48,8 +49,12 @@ Note: *The memory parameter value must be a multiple of 256, e.g. 256, 512, 768,
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    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
+```text
+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
+```

data/docs/subcommands/server_delete.md

@@ -2,20 +2,21 @@
 
 This will remove a server from a VDC.
 
-**NOTE**: This will not automatically remove the storage volume(s) attached to a server. A separate API call is required to perform that action.
-
-    knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
+**NOTE**: This will not automatically remove the storage volume\(s\) attached to a server. A separate API call is required to perform that action.
 
+```text
+knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -25,8 +26,12 @@ This will remove a server from a VDC.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server delete SERVER_ID 
+```text
+knife ionoscloud server delete SERVER_ID 
+```

data/docs/subcommands/server_get.md

@@ -0,0 +1,39 @@
+# ServerGet
+
+Retrieves the attributes of a given Server.
+
+```text
+knife ionoscloud server get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud server get --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/server_list.md

@@ -2,18 +2,19 @@
 
 List all available servers under a specified data center.
 
-    knife ionoscloud server list (options)
-
+```text
+knife ionoscloud server list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         the ID of the datacenter containing the server (required)
 
@@ -23,8 +24,12 @@ List all available servers under a specified data center.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/server_reboot.md

@@ -2,18 +2,19 @@
 
 This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.
 
-    knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
-
+```text
+knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the data center (required)
 
@@ -23,8 +24,12 @@ This will force a hard reboot of the server. Do not use this method if you want
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server reboot SERVER_ID 
+```text
+knife ionoscloud server reboot SERVER_ID 
+```

data/docs/subcommands/server_start.md

@@ -1,19 +1,20 @@
 # ServerStart
 
-This will start a server. If the server's public IP was deallocated then a new IP will be assigned.
-
-    knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
+This will start a server. If the server's public IP was deallocated then a new IP will be assigned.
 
+```text
+knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the data center (required)
 
@@ -23,8 +24,12 @@ This will start a server. If the server's public IP was deallocated then a n
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server start SERVER_ID 
+```text
+knife ionoscloud server start SERVER_ID 
+```

data/docs/subcommands/server_stop.md

@@ -2,18 +2,19 @@
 
 This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated.
 
-    knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
-
+```text
+knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the data center (required)
 
@@ -23,8 +24,12 @@ This will stop a server. The machine will be forcefully powered off, billing wil
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server stop SERVER_ID 
+```text
+knife ionoscloud server stop SERVER_ID 
+```

data/docs/subcommands/server_update.md

@@ -0,0 +1,60 @@
+# ServerUpdate
+
+Updates information about a Ionoscloud Server.
+
+```text
+knife ionoscloud server update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    cores: --cores CORES, -C CORES
+        the number of processor cores
+
+    cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
+        the family of the CPU (INTEL_XEON or AMD_OPTERON)
+
+    ram: --ram RAM, -r RAM
+        the amount of RAM in MB
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
+        the availability zone of the server
+
+    boot_volume: --boot-volume VOLUME_ID
+        reference to a volume used for booting
+
+    boot_cdrom: --boot-cdrom CDROM_ID
+        reference to a CD-ROM used for booting
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud server update --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 --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/share_create.md

@@ -2,26 +2,27 @@
 
 Adds a specific resource share to a group and optionally allows the setting of permissions for that resource. As an example, you might use this to grant permissions to use an image or snapshot to a specific group.
 
-    knife ionoscloud share create (options)
-
+```text
+knife ionoscloud share create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* group_id
-* resource_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* group\_id
+* resource\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -G GROUP_ID
         iD of the group. (required)
 
     resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
         the ID of the resource. (required)
 
-    edit_privilege: --edit, -e
+    edit_privilege: --edit
         the group has permission to edit privileges on this resource.
 
     share_privilege: --share, -s
@@ -33,8 +34,12 @@ Adds a specific resource share to a group and optionally allows the setting of p
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD
+```text
+knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/share_delete.md

@@ -2,18 +2,19 @@
 
 Removes a resource share from a specified group.
 
-    knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
-
+```text
+knife ionoscloud server delete RESOURCE_ID [RESOURCE_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* group_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* group\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -G GROUP_ID
         iD of the group. (required)
 
@@ -23,8 +24,12 @@ Removes a resource share from a specified group.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud server delete SHARE_ID 
+```text
+knife ionoscloud server delete RESOURCE_ID 
+```

data/docs/subcommands/share_get.md

@@ -0,0 +1,39 @@
+# ShareGet
+
+Retrieves the attributes of a given Group Share.
+
+```text
+knife ionoscloud share get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* group\_id
+* resource\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    group_id: --group-id GROUP_ID, -G GROUP_ID
+        iD of the group. (required)
+
+    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
+        the ID of the resource. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud share get --group-id GROUP_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/share_list.md

@@ -2,18 +2,19 @@
 
 Retrieves a full list of all the resources that are shared through this group and lists the permissions granted to the group members for each shared resource.
 
-    knife ionoscloud share list (options)
-
+```text
+knife ionoscloud share list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* group_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* group\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -G GROUP_ID
         iD of the group. (required)
 
@@ -23,8 +24,12 @@ Retrieves a full list of all the resources that are shared through this group an
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud share list --group-id GROUP_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud share list --group-id GROUP_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```