knife-ionoscloud 5.0.0 → 5.1.0

data/docs/subcommands/request_status.md

@@ -23,11 +23,10 @@ knife ionoscloud request status (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/request_wait.md

@@ -23,11 +23,10 @@ knife ionoscloud request wait (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/resource_list.md

@@ -2,6 +2,8 @@
 
 No option: Retrieves a list of all resources and optionally their group associations. Please Note: This API call can take a significant amount of time to return when there are a large number of provisioned resources. You may wish to consult the next section on how to list resources of a particular type.
 
+
+
 ```text
 knife ionoscloud resource list (options)
 ```
@@ -25,11 +27,10 @@ knife ionoscloud resource list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/s3key_create.md

@@ -23,11 +23,10 @@ knife ionoscloud s3key create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/s3key_delete.md

@@ -23,11 +23,10 @@ knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud s3key delete S3KEY_ID 
 ```
-

data/docs/subcommands/s3key_list.md

@@ -23,11 +23,10 @@ knife ionoscloud s3key list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/server_create.md

@@ -48,11 +48,10 @@ knife ionoscloud server create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```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
 ```
-

data/docs/subcommands/server_delete.md

@@ -25,11 +25,10 @@ knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server delete SERVER_ID 
 ```
-

data/docs/subcommands/server_list.md

@@ -23,11 +23,10 @@ knife ionoscloud server list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/server_reboot.md

@@ -23,11 +23,10 @@ knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server reboot SERVER_ID 
 ```
-

data/docs/subcommands/server_start.md

@@ -23,11 +23,10 @@ knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server start SERVER_ID 
 ```
-

data/docs/subcommands/server_stop.md

@@ -23,11 +23,10 @@ knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server stop SERVER_ID 
 ```
-

data/docs/subcommands/share_create.md

@@ -33,11 +33,10 @@ knife ionoscloud share create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/share_delete.md

@@ -23,11 +23,10 @@ knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud server delete SHARE_ID 
 ```
-

data/docs/subcommands/share_list.md

@@ -23,11 +23,10 @@ knife ionoscloud share list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud share list --group-id GROUP_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/snapshot_create.md

@@ -22,16 +22,27 @@ knife ionoscloud snapshot create (options)
     volume_id: --volume VOLUME_ID, -V VOLUME_ID
         iD of the Volume (required)
 
+    name: --name SNAPSHOT_NAME, -n SNAPSHOT_NAME
+        name of the snapshot
+
+    description: --description SNAPSHOT_DESCRIPTION
+        description of the snapshot
+
+    sec_auth_protection: --sec-auth
+        flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc.
+
+    licence_type: --licence LICENCE_TYPE, -l LICENCE_TYPE
+        the OS type of this Snapshot
+
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
-knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD
+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
 ```
-

data/docs/subcommands/snapshot_delete.md

@@ -19,11 +19,10 @@ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/snapshot_list.md

@@ -19,11 +19,10 @@ knife ionoscloud snapshot list
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud snapshot list--username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/snapshot_restore.md

@@ -31,11 +31,10 @@ knife ionoscloud snapshot restore (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud snapshot restore --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/user_create.md

@@ -33,7 +33,7 @@ knife ionoscloud user create (options)
     administrator: --admin ADMIN, -a ADMIN
         assigns the user have administrative rights.
 
-    force_sec_auth: --sec-auth SEC_AUTH
+    force_sec_auth: --sec-auth
         indicates if secure (two-factor) authentication should be forced for the user.
 
     ionoscloud_username: --username USERNAME, -u USERNAME
@@ -41,11 +41,10 @@ knife ionoscloud user create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
-knife ionoscloud user create --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --sec-auth SEC_AUTH --username USERNAME --password PASSWORD
+knife ionoscloud user create --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --sec-auth --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/user_delete.md

@@ -19,11 +19,10 @@ knife ionoscloud user delete USER_ID [USER_ID]
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud user delete USER_ID [USER_ID]--username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/user_list.md

@@ -22,11 +22,10 @@ knife ionoscloud user list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud user list --group-id GROUP_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/user_ssourl.md

@@ -23,11 +23,10 @@ knife ionoscloud user ssourl (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/volume_attach.md

@@ -27,11 +27,10 @@ knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud volume attach VOLUME_ID 
 ```
-

data/docs/subcommands/volume_create.md

@@ -56,11 +56,10 @@ knife ionoscloud volume create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud volume create --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 --username USERNAME --password PASSWORD
 ```
-

data/docs/subcommands/volume_delete.md

@@ -23,11 +23,10 @@ knife ionoscloud volume delete SERVER_ID [SERVER_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud volume delete SERVER_ID 
 ```
-

data/docs/subcommands/volume_detach.md

@@ -29,11 +29,10 @@ knife ionoscloud volume detach VOLUME_ID [VOLUME_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud volume detach VOLUME_ID 
 ```
-

data/docs/subcommands/volume_list.md

@@ -26,11 +26,10 @@ knife ionoscloud volume list (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+```
 ## Example
 
 ```text
 knife ionoscloud volume list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
 ```
-

data/docs/summary.md

@@ -87,4 +87,3 @@
 * [VolumeDelete](subcommands/volume_delete.md)
 * [VolumeDetach](subcommands/volume_detach.md)
 * [VolumeList](subcommands/volume_list.md)
-

data/docs/templates/subcommand_doc.mustache

@@ -1,26 +1,28 @@
 # {{name}}
 
-{{description}}
-
-    {{banner}}
+{{{description}}}
 
+```text
+{{banner}}
+```
 
 ## Available options:
----
 
 ### Required options:
+
 {{#required_options}}
 * {{.}}
 {{/required_options}}
 
-```
+```text
 {{#options}}
     {{name}}: {{long}}{{#short}}, {{short}}{{/short}}
         {{{description}}}{{#required}} (required){{/required}}
 
 {{/options}}
 ```
-
 ## Example
 
-    {{example}}
+```text
+{{example}}
+```