knife-ionoscloud 5.0.0.beta.1

data/docs/subcommands/s3key_delete.md

@@ -0,0 +1,30 @@
+# S3keyDelete
+
+This operation deletes a specific S3 key.
+
+    knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* user_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    user_id: --user USER_ID, -u USER_ID
+        the ID of the user (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud s3key delete S3KEY_ID 

data/docs/subcommands/s3key_list.md

@@ -0,0 +1,30 @@
+# S3keyList
+
+Retrieve a list of all the S3 keys for a specific user.
+
+    knife ionoscloud s3key list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* user_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    user_id: --user USER_ID, -u USER_ID
+        the ID of the user (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/server_create.md

@@ -0,0 +1,55 @@
+# ServerCreate
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* cores
+* ram
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the virtual datacenter (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    cores: --cores CORES, -C CORES
+        the number of processor cores (required)
+
+    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 (required)
+
+    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)
+
+```
+
+## 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

data/docs/subcommands/server_delete.md

@@ -0,0 +1,32 @@
+# ServerDelete
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud server delete SERVER_ID 

data/docs/subcommands/server_list.md

@@ -0,0 +1,30 @@
+# ServerList
+
+List all available servers under a specified data center.
+
+    knife ionoscloud server list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the datacenter containing the server (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/server_reboot.md

@@ -0,0 +1,30 @@
+# ServerReboot
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud server reboot SERVER_ID 

data/docs/subcommands/server_start.md

@@ -0,0 +1,30 @@
+# 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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud server start SERVER_ID 

data/docs/subcommands/server_stop.md

@@ -0,0 +1,30 @@
+# ServerStop
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud server stop SERVER_ID 

data/docs/subcommands/share_create.md

@@ -0,0 +1,40 @@
+# ShareCreate
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* resource_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    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
+        the group has permission to edit privileges on this resource.
+
+    share_privilege: --share, -s
+        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)
+
+```
+
+## Example
+
+    knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD

data/docs/subcommands/share_delete.md

@@ -0,0 +1,30 @@
+# ShareDelete
+
+Removes a resource share from a specified group.
+
+    knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -G GROUP_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)
+
+```
+
+## Example
+
+    knife ionoscloud server delete SHARE_ID 

data/docs/subcommands/share_list.md

@@ -0,0 +1,30 @@
+# ShareList
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -G GROUP_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)
+
+```
+
+## Example
+
+    knife ionoscloud share list --group-id GROUP_ID --username USERNAME --password PASSWORD

data/docs/subcommands/snapshot_create.md

@@ -0,0 +1,34 @@
+# SnapshotCreate
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* volume_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    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)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD

data/docs/subcommands/snapshot_delete.md

@@ -0,0 +1,26 @@
+# SnapshotDelete
+
+Deletes the specified snapshot.
+
+    knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD