knife-ionoscloud 5.0.0.beta.1

data/docs/subcommands/snapshot_list.md

@@ -0,0 +1,26 @@
+# SnapshotList
+
+Retrieve a list of snapshots.
+
+    knife ionoscloud snapshot list
+
+
+## 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 list--username USERNAME --password PASSWORD

data/docs/subcommands/snapshot_restore.md

@@ -0,0 +1,38 @@
+# SnapshotRestore
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* volume_id
+* snapshot_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)
+
+    snapshot_id: --snapshot SNAPSHOT_ID, -S SNAPSHOT_ID
+        iD of the Snapshot (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 restore --datacenter DATACENTER_ID --volume VOLUME_ID --snapshot SNAPSHOT_ID --username USERNAME --password PASSWORD

data/docs/subcommands/user_create.md

@@ -0,0 +1,49 @@
+# 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)
+
+
+## Available options:
+---
+
+### Required options:
+* firstname
+* lastname
+* email
+* password
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    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
+        an e-mail address for the user. (required)
+
+    password: --password PASSWORD, -p PASSWORD
+        a password for the user. (required)
+
+    administrator: --admin ADMIN, -a ADMIN
+        assigns the user have administrative rights.
+
+    force_sec_auth: --sec-auth SEC_AUTH
+        indicates if secure (two-factor) authentication should be forced for the user.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    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

data/docs/subcommands/user_delete.md

@@ -0,0 +1,26 @@
+# UserDelete
+
+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]
+
+
+## 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 user delete USER_ID [USER_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/user_list.md

@@ -0,0 +1,29 @@
+# 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)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -g GROUP_ID
+        iD of the group.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud user list --group-id GROUP_ID --username USERNAME --password PASSWORD

data/docs/subcommands/user_ssourl.md

@@ -0,0 +1,30 @@
+# UserSsourl
+
+Retrieve S3 object storage single signon URL for the given user.
+
+    knife ionoscloud user ssourl (options)
+
+
+## Available options:
+---
+
+### Required options:
+* user_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    user_id: --user-id USER_ID, -U USER_ID
+        the ID of the Backup unit. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud user ssourl --user-id USER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/volume_attach.md

@@ -0,0 +1,34 @@
+# VolumeAttach
+
+This will attach a pre-existing storage volume to the server.
+
+    knife ionoscloud volume attach VOLUME_ID [VOLUME_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* server_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of 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 volume attach VOLUME_ID 

data/docs/subcommands/volume_create.md

@@ -0,0 +1,63 @@
+# VolumeCreate
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* name
+* type
+* size
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    name: --name NAME, -n NAME
+        name of the volume (required)
+
+    size: --size SIZE, -S SIZE
+        the size of the volume in GB (required)
+
+    bus: --bus BUS, -b BUS
+        the bus type of the volume (VIRTIO or IDE)
+
+    image: --image ID, -N ID
+        the image or snapshot ID
+
+    image_alias: --image-alias IMAGE_ALIAS
+        (required) The image alias
+
+    image_password: --image-password PASSWORD, -P PASSWORD
+        the password set on the image for the "root" or "Administrator" user
+
+    type: --type TYPE, -t TYPE
+        the disk type (HDD OR SSD) (required)
+
+    licence_type: --licence-type LICENCE, -l LICENCE
+        the licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)
+
+    ssh_keys: --ssh-keys SSHKEY1,SSHKEY2,..., -K SSHKEY[,SSHKEY,...]
+        a list of public SSH keys to include
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -Z AVAILABILITY_ZONE
+        the volume availability zone of the server
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    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

data/docs/subcommands/volume_delete.md

@@ -0,0 +1,30 @@
+# VolumeDelete
+
+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)
+
+
+## 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 volume delete SERVER_ID 

data/docs/subcommands/volume_detach.md

@@ -0,0 +1,36 @@
+# VolumeDetach
+
+This will detach the volume from the server. Depending on the volume HotUnplug settings, this may result in the server being rebooted.
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* server_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of 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 volume detach VOLUME_ID 

data/docs/subcommands/volume_list.md

@@ -0,0 +1,33 @@
+# VolumeList
+
+List all available volumes under a data center. You can also list all volumes attached to a specific server.
+
+    knife ionoscloud volume 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 virtul data center containing the volume (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    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

data/docs/summary.md

@@ -0,0 +1,89 @@
+# Table of contents
+
+* [Introduction](README.md)
+* [Changelog](changelog.md)
+
+## Subcommands
+
+* [BackupunitCreate](subcommands/backupunit_create.md)
+* [BackupunitDelete](subcommands/backupunit_delete.md)
+* [BackupunitList](subcommands/backupunit_list.md)
+* [BackupunitSsourl](subcommands/backupunit_ssourl.md)
+* [CompositeServerCreate](subcommands/composite_server_create.md)
+* [ContractList](subcommands/contract_list.md)
+* [DatacenterCreate](subcommands/datacenter_create.md)
+* [DatacenterDelete](subcommands/datacenter_delete.md)
+* [DatacenterList](subcommands/datacenter_list.md)
+* [FirewallCreate](subcommands/firewall_create.md)
+* [FirewallDelete](subcommands/firewall_delete.md)
+* [FirewallList](subcommands/firewall_list.md)
+* [GroupCreate](subcommands/group_create.md)
+* [GroupDelete](subcommands/group_delete.md)
+* [GroupGet](subcommands/group_get.md)
+* [GroupList](subcommands/group_list.md)
+* [GroupUserAdd](subcommands/group_user_add.md)
+* [GroupUserRemove](subcommands/group_user_remove.md)
+* [ImageList](subcommands/image_list.md)
+* [IpblockCreate](subcommands/ipblock_create.md)
+* [IpblockDelete](subcommands/ipblock_delete.md)
+* [IpblockList](subcommands/ipblock_list.md)
+* [IpfailoverAdd](subcommands/ipfailover_add.md)
+* [IpfailoverRemove](subcommands/ipfailover_remove.md)
+* [K8sCreate](subcommands/k8s_create.md)
+* [K8sDelete](subcommands/k8s_delete.md)
+* [K8sList](subcommands/k8s_list.md)
+* [KubeconfigGet](subcommands/kubeconfig_get.md)
+* [LabelAdd](subcommands/label_add.md)
+* [LabelList](subcommands/label_list.md)
+* [LabelRemove](subcommands/label_remove.md)
+* [LanCreate](subcommands/lan_create.md)
+* [LanDelete](subcommands/lan_delete.md)
+* [LanList](subcommands/lan_list.md)
+* [LoadbalancerCreate](subcommands/loadbalancer_create.md)
+* [LoadbalancerDelete](subcommands/loadbalancer_delete.md)
+* [LoadbalancerGet](subcommands/loadbalancer_get.md)
+* [LoadbalancerList](subcommands/loadbalancer_list.md)
+* [LoadbalancerNicAdd](subcommands/loadbalancer_nic_add.md)
+* [LoadbalancerNicRemove](subcommands/loadbalancer_nic_remove.md)
+* [LocationList](subcommands/location_list.md)
+* [NicCreate](subcommands/nic_create.md)
+* [NicDelete](subcommands/nic_delete.md)
+* [NicList](subcommands/nic_list.md)
+* [NodeDelete](subcommands/node_delete.md)
+* [NodeList](subcommands/node_list.md)
+* [NodeReplace](subcommands/node_replace.md)
+* [NodepoolCreate](subcommands/nodepool_create.md)
+* [NodepoolDelete](subcommands/nodepool_delete.md)
+* [NodepoolList](subcommands/nodepool_list.md)
+* [PccCreate](subcommands/pcc_create.md)
+* [PccDelete](subcommands/pcc_delete.md)
+* [PccList](subcommands/pcc_list.md)
+* [RequestList](subcommands/request_list.md)
+* [RequestStatus](subcommands/request_status.md)
+* [RequestWait](subcommands/request_wait.md)
+* [ResourceList](subcommands/resource_list.md)
+* [S3keyCreate](subcommands/s3key_create.md)
+* [S3keyDelete](subcommands/s3key_delete.md)
+* [S3keyList](subcommands/s3key_list.md)
+* [ServerCreate](subcommands/server_create.md)
+* [ServerDelete](subcommands/server_delete.md)
+* [ServerList](subcommands/server_list.md)
+* [ServerReboot](subcommands/server_reboot.md)
+* [ServerStart](subcommands/server_start.md)
+* [ServerStop](subcommands/server_stop.md)
+* [ShareCreate](subcommands/share_create.md)
+* [ShareDelete](subcommands/share_delete.md)
+* [ShareList](subcommands/share_list.md)
+* [SnapshotCreate](subcommands/snapshot_create.md)
+* [SnapshotDelete](subcommands/snapshot_delete.md)
+* [SnapshotList](subcommands/snapshot_list.md)
+* [SnapshotRestore](subcommands/snapshot_restore.md)
+* [UserCreate](subcommands/user_create.md)
+* [UserDelete](subcommands/user_delete.md)
+* [UserList](subcommands/user_list.md)
+* [UserSsourl](subcommands/user_ssourl.md)
+* [VolumeAttach](subcommands/volume_attach.md)
+* [VolumeCreate](subcommands/volume_create.md)
+* [VolumeDelete](subcommands/volume_delete.md)
+* [VolumeDetach](subcommands/volume_detach.md)
+* [VolumeList](subcommands/volume_list.md)