knife-ionoscloud 5.0.0.beta.1 → 5.0.0

data/docs/subcommands/snapshot_list.md

@@ -2,25 +2,28 @@
 
 Retrieve a list of snapshots.
 
-    knife ionoscloud snapshot list
-
+```text
+knife ionoscloud snapshot list
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud snapshot list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud snapshot list--username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/snapshot_restore.md

@@ -2,20 +2,21 @@
 
 This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create new volumes or to restore an existing volume.
 
-    knife ionoscloud snapshot restore (options)
-
+```text
+knife ionoscloud snapshot restore (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* volume_id
-* snapshot_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* volume\_id
+* snapshot\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter DATACENTER_ID, -D DATACENTER_ID
         iD of the Datacenter (required)
 
@@ -30,9 +31,11 @@ This will restore a snapshot onto a volume. A snapshot is created as just anothe
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud snapshot restore --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud snapshot restore --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/user_create.md

@@ -1,23 +1,23 @@
 # UserCreate
 
-Creates a new user under a particular contract.
-**Please Note**: The password set here cannot be updated through the API currently. It is recommended that a new user log into the DCD and change their password.
-
-    knife ionoscloud user create (options)
+Creates a new user under a particular contract. **Please Note**: The password set here cannot be updated through the API currently. It is recommended that a new user log into the DCD and change their password.
 
+```text
+knife ionoscloud user create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * firstname
 * lastname
 * email
 * password
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     firstname: --firstname FIRSTNAME, -f FIRSTNAME
         firstname of the user. (required)
 
@@ -41,9 +41,11 @@ Creates a new user under a particular contract.
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud user create --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --sec-auth SEC_AUTH --username USERNAME --password PASSWORD
+```text
+knife ionoscloud user create --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --password PASSWORD --admin ADMIN --sec-auth SEC_AUTH --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/user_delete.md

@@ -2,25 +2,28 @@
 
 Blacklists the user, disabling them. The user is not completely purged, therefore if you anticipate needing to create a user with the same name in the future, we suggest renaming the user before you delete it.
 
-    knife ionoscloud user delete USER_ID [USER_ID]
-
+```text
+knife ionoscloud user delete USER_ID [USER_ID]
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud user delete USER_ID [USER_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud user delete USER_ID [USER_ID]--username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/user_list.md

@@ -1,18 +1,19 @@
 # UserList
 
-Retrieve a list of all the users that have been created under a contract. You can retrieve a list of users who are members of the group by passing the *group_id* option.
-
-    knife ionoscloud user list (options)
+Retrieve a list of all the users that have been created under a contract. You can retrieve a list of users who are members of the group by passing the _group\_id_ option.
 
+```text
+knife ionoscloud user list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -g GROUP_ID
         iD of the group.
 
@@ -21,9 +22,11 @@ Retrieve a list of all the users that have been created under a contract. You ca
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud user list --group-id GROUP_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud user list --group-id GROUP_ID --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/user_ssourl.md

@@ -2,18 +2,19 @@
 
 Retrieve S3 object storage single signon URL for the given user.
 
-    knife ionoscloud user ssourl (options)
-
+```text
+knife ionoscloud user ssourl (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* user_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     user_id: --user-id USER_ID, -U USER_ID
         the ID of the Backup unit. (required)
 
@@ -22,9 +23,11 @@ Retrieve S3 object storage single signon URL for the given user.
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/volume_attach.md

@@ -2,19 +2,20 @@
 
 This will attach a pre-existing storage volume to the server.
 
-    knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
-
+```text
+knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* server\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         the ID of the data center (required)
 
@@ -26,9 +27,11 @@ This will attach a pre-existing storage volume to the server.
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud volume attach VOLUME_ID 
+```text
+knife ionoscloud volume attach VOLUME_ID 
+```
+

data/docs/subcommands/volume_create.md

@@ -2,21 +2,22 @@
 
 Creates a volume within the data center. This will NOT attach the volume to a server. Please see the Servers section for details on how to attach storage volumes.
 
-    knife ionoscloud volume create (options)
-
+```text
+knife ionoscloud volume create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
+
+* datacenter\_id
 * name
 * type
 * size
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -55,9 +56,11 @@ Creates a volume within the data center. This will NOT attach the volume to a se
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    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
+```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

@@ -2,18 +2,19 @@
 
 Deletes the specified volume. This will result in the volume being removed from your virtual data center. Please use this with caution!
 
-    knife ionoscloud volume delete SERVER_ID [SERVER_ID] (options)
-
+```text
+knife ionoscloud volume 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)
 
@@ -22,9 +23,11 @@ Deletes the specified volume. This will result in the volume being removed from
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud volume delete SERVER_ID 
+```text
+knife ionoscloud volume delete SERVER_ID 
+```
+

data/docs/subcommands/volume_detach.md

@@ -4,19 +4,20 @@ This will detach the volume from the server. Depending on the volume HotUnplug s
 
 This will NOT delete the volume from your virtual data center. You will need to make a separate request to delete a volume.
 
-    knife ionoscloud volume detach VOLUME_ID [VOLUME_ID] (options)
-
+```text
+knife ionoscloud volume detach VOLUME_ID [VOLUME_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* server\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         the ID of the data center (required)
 
@@ -28,9 +29,11 @@ This will NOT delete the volume from your virtual data center. You will need to
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud volume detach VOLUME_ID 
+```text
+knife ionoscloud volume detach VOLUME_ID 
+```
+

data/docs/subcommands/volume_list.md

@@ -2,18 +2,19 @@
 
 List all available volumes under a data center. You can also list all volumes attached to a specific server.
 
-    knife ionoscloud volume list (options)
-
+```text
+knife ionoscloud volume 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 virtul data center containing the volume (required)
 
@@ -25,9 +26,11 @@ List all available volumes under a data center. You can also list all volumes at
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud volume list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud volume list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
+```
+