knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/share_update.md

@@ -0,0 +1,45 @@
+# ShareUpdate
+
+Updates information about a Ionoscloud Group Share.
+
+```text
+knife ionoscloud share update (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)
+
+    edit_privilege: --edit EDIT_PRIVILEGE
+        the group has permission to edit privileges on this resource.
+
+    share_privilege: --share SHARE_PRIVILEGE, -s SHARE_PRIVILEGE
+        the group has permission to share this resource.
+
+    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 update --group-id GROUP_ID --resource-id RESOURCE_ID --edit EDIT_PRIVILEGE --share SHARE_PRIVILEGE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/snapshot_create.md

@@ -2,33 +2,50 @@
 
 Creates a snapshot of a volume within the virtual data center. You can use a snapshot to create a new storage volume or to restore a storage volume.
 
-    knife ionoscloud snapshot create (options)
-
+```text
+knife ionoscloud snapshot create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* volume_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* volume\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter DATACENTER_ID, -D DATACENTER_ID
         iD of the Datacenter (required)
 
     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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD
+```text
+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
+```

data/docs/subcommands/snapshot_delete.md

@@ -2,25 +2,30 @@
 
 Deletes the specified snapshot.
 
-    knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]
-
+```text
+knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/snapshot_get.md

@@ -0,0 +1,35 @@
+# SnapshotGet
+
+Retrieves the attributes of a given Snapshot.
+
+```text
+knife ionoscloud snapshot get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* snapshot\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_ID
+        iD of the group. (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 snapshot get --snapshot-id SNAPSHOT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/snapshot_list.md

@@ -2,25 +2,30 @@
 
 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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud snapshot list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud snapshot list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

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)
 
@@ -31,8 +32,12 @@ 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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## 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 --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/snapshot_update.md

@@ -0,0 +1,77 @@
+# SnapshotUpdate
+
+Updates information about a Ionoscloud Snapshot.
+
+```text
+knife ionoscloud snapshot update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* snapshot\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_ID
+        iD of the Snapshot. (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    description: --description DESCRIPTION
+        the number of processor cores
+
+    sec_auth_protection: --sec-auth-protection SEC_AUTH_PROTECTION
+        boolean value representing if the snapshot requires extra protection e.g. two factor protection
+
+    licence_type: --licence-type LICENCE, -l LICENCE
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    cpu_hot_plug: --cpu-hot-plug CPU_HOT_PLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    cpu_hot_unplug: --cpu-hot-unplug CPU_HOT_UNPLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    ram_hot_plug: --ram-hot-plug RAM_HOT_PLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    ram_hot_unplug: --ram-hot-unplug RAM_HOT_UNPLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    nic_hot_plug: --nic-hot-plug NIC_HOT_PLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    nic_hot_unplug: --nic-hot-unplug NIC_HOT_UNPLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    disc_virtio_hot_plug: --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    disc_virtio_hot_unplug: --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    disc_scsi_hot_plug: --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    disc_scsi_hot_unplug: --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG
+        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    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 snapshot update --snapshot-id SNAPSHOT_ID --name NAME --description DESCRIPTION --sec-auth-protection SEC_AUTH_PROTECTION --licence-type LICENCE --cpu-hot-plug CPU_HOT_PLUG --cpu-hot-unplug CPU_HOT_UNPLUG --ram-hot-plug RAM_HOT_PLUG --ram-hot-unplug RAM_HOT_UNPLUG --nic-hot-plug NIC_HOT_PLUG --nic-hot-unplug NIC_HOT_UNPLUG --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/user_create.md

@@ -1,30 +1,30 @@
 # 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)
 
     lastname: --lastname LASTNAME, -l LASTNAME
         lastname of the user. (required)
 
-    email: --email EMAIL, -e EMAIL
+    email: --email EMAIL
         an e-mail address for the user. (required)
 
     password: --password PASSWORD, -p PASSWORD
@@ -33,17 +33,27 @@ Creates a new user under a particular contract.
     administrator: --admin ADMIN, -a ADMIN
         assigns the user have administrative rights.
 
-    force_sec_auth: --sec-auth SEC_AUTH
+    force_sec_auth: --force-sec-auth
         indicates if secure (two-factor) authentication should be forced for the user.
 
+    sec_auth_active: --sec-auth
+        indicates if secure authentication is active for the user or not.
+
+    active: --active
+        indicates if the user is active.
+
     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
 
-    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 --force-sec-auth --sec-auth --active --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/user_delete.md

@@ -2,25 +2,30 @@
 
 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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## 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 --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/user_get.md

@@ -0,0 +1,35 @@
+# UserGet
+
+Retrieves the attributes of a given Ionoscloud User.
+
+```text
+knife ionoscloud user get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    user_id: --user-id USER_ID, -U USER_ID
+        iD of the group. (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 user get --user-id USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

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.
 
@@ -22,8 +23,12 @@ 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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## 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 --extra-config EXTRA_CONFIG_FILE_PATH
+```

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)
 
@@ -23,8 +24,12 @@ Retrieve S3 object storage single signon URL for the given 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 user ssourl --user-id USER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/user_update.md

@@ -0,0 +1,56 @@
+# UserUpdate
+
+Updates information about a Ionoscloud User.
+
+```text
+knife ionoscloud user update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    user_id: --user-id USER_ID, -U USER_ID
+        iD of the User. (required)
+
+    firstname: --firstname FIRSTNAME, -f FIRSTNAME
+        firstname of the user.
+
+    lastname: --lastname LASTNAME, -l LASTNAME
+        lastname of the user.
+
+    email: --email EMAIL
+        an e-mail address for the user.
+
+    administrator: --admin ADMIN, -a ADMIN
+        assigns the user have administrative rights.
+
+    force_sec_auth: --sec-auth FORCE_SEC_AUTH
+        indicates if secure (two-factor) authentication should be forced for the user.
+
+    sec_auth_active: --sec-auth SEC_AUTH_ACTIVE
+        indicates if secure authentication is active for the user or not.
+
+    active: --active ACTIVE
+        indicates if the user is active.
+
+    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 user update --user-id USER_ID --firstname FIRSTNAME --lastname LASTNAME --email EMAIL --admin ADMIN --sec-auth FORCE_SEC_AUTH --sec-auth SEC_AUTH_ACTIVE --active ACTIVE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

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)
 
@@ -27,8 +28,12 @@ This will attach a pre-existing storage volume to the server.
     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 volume attach VOLUME_ID 
+```text
+knife ionoscloud volume attach VOLUME_ID 
+```