knife-ionoscloud 5.0.0.beta.1

data/docs/subcommands/ipblock_delete.md

@@ -0,0 +1,26 @@
+# IpblockDelete
+
+Releases a currently assigned IP block.
+
+    knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_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 ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/ipblock_list.md

@@ -0,0 +1,26 @@
+# IpblockList
+
+Lists all available IP blocks.
+
+    knife ionoscloud ipblock 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 ipblock list--username USERNAME --password PASSWORD

data/docs/subcommands/ipfailover_add.md

@@ -0,0 +1,46 @@
+# IpfailoverAdd
+
+Successfully setting up an IP Failover group requires three steps:
+* Add a reserved IP address to a NIC that will become the IP Failover master.
+* Use PATCH or PUT to enable ipFailover by providing the relevant ip and nicUuid values.
+* Add the same reserved IP address to any other NICs that are a member of the same LAN. Those NICs will become IP Failover members.
+
+
+    knife ionoscloud ipfailover add (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* lan_id
+* ip
+* nic_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    lan_id: --lan-id LAN_ID, -l LAN_ID
+        lan ID (required)
+
+    ip: --ip IP, -i IP
+        iP to be added to IP failover group (required)
+
+    nic_id: --nic-id NIC_ID, -n NIC_ID
+        nIC to be added to IP failover 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 ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD

data/docs/subcommands/ipfailover_remove.md

@@ -0,0 +1,42 @@
+# IpfailoverRemove
+
+Remove IP Failover from LAN
+
+    knife ionoscloud ipfailover remove (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* lan_id
+* ip
+* nic_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    lan_id: --lan-id LAN_ID, -l LAN_ID
+        lan ID (required)
+
+    ip: --ip IP, -i IP
+        iP to be removed from the IP failover group (required)
+
+    nic_id: --nic-id NIC_ID, -n NIC_ID
+        nIC to be removed from the IP failover 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 ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD

data/docs/subcommands/k8s_create.md

@@ -0,0 +1,39 @@
+# K8sCreate
+
+Creates a new Managed Kubernetes cluster.
+
+    knife ionoscloud k8s create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* name
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    name: --name NAME, -n NAME
+        name of the server (required)
+
+    version: --version VERSION, -v VERSION
+        the version for the Kubernetes cluster.
+
+    maintenance_day: --maintenance-day MAINTENANCE_DAY, -d MAINTENANCE_DAY
+        day Of the week when to perform the maintenance.
+
+    maintenance_time: --maintenance-time MAINTENANCE_TIME, -t MAINTENANCE_TIME
+        time Of the day when to perform the maintenance.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud k8s create --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD

data/docs/subcommands/k8s_delete.md

@@ -0,0 +1,26 @@
+# K8sDelete
+
+Deletes a Kubernetes cluster. The cluster cannot contain any node pools when deleting.
+
+    knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_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 k8s delete CLUSTER_ID [CLUSTER_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/k8s_list.md

@@ -0,0 +1,26 @@
+# K8sList
+
+Retrieve a list of Kubernetes clusters.
+
+    knife ionoscloud k8s 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 k8s list--username USERNAME --password PASSWORD

data/docs/subcommands/kubeconfig_get.md

@@ -0,0 +1,30 @@
+# KubeconfigGet
+
+Retrieve the kubeconfig file for a given Kubernetes cluster.
+
+    knife ionoscloud kubeconfig get (options)
+
+
+## Available options:
+---
+
+### Required options:
+* cluster_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        the ID of the Kubernetes cluster. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud kubeconfig get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/label_add.md

@@ -0,0 +1,45 @@
+# LabelAdd
+
+Add a Label to a Resource.
+
+    knife ionoscloud label add (options)
+
+
+## Available options:
+---
+
+### Required options:
+* type
+* resource_id
+* key
+* value
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
+        type of the resource to be labeled. Must be one of [datacenter, server, volume, ipblock, snapshot] (required)
+
+    key: --key KEY, -K KEY
+        key of the label. (required)
+
+    value: --value VALUE
+        value of the label. (required)
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center.
+
+    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
+        iD of the resource. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud label add --resource-type RESOURCE_TYPE --key KEY --value VALUE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD

data/docs/subcommands/label_list.md

@@ -0,0 +1,35 @@
+# LabelList
+
+List all Labels available to the user. Specify the type and required resource ID to list labels for a specific resource instead.
+
+    knife ionoscloud label list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
+        type of the resource to be labeled.
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center.
+
+    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
+        iD of the resource.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud label list --resource-type RESOURCE_TYPE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD

data/docs/subcommands/label_remove.md

@@ -0,0 +1,37 @@
+# LabelRemove
+
+Remove a Label from a Resource.
+
+    knife ionoscloud label remove LABEL_KEY [LABEL_KEY] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* type
+* resource_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
+        type of the resource to be labeled. (required)
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center.
+
+    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
+        iD of the resource. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud label remove LABEL_KEY 

data/docs/subcommands/lan_create.md

@@ -0,0 +1,36 @@
+# LanCreate
+
+Creates a new LAN under a data center.
+
+    knife ionoscloud lan create (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)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    public: --public, -p
+        boolean indicating if the LAN faces the public Internet or not; defaults to false
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud lan create --datacenter-id DATACENTER_ID --name NAME --public --username USERNAME --password PASSWORD

data/docs/subcommands/lan_delete.md

@@ -0,0 +1,30 @@
+# LanDelete
+
+Deletes an existing LAN.
+
+    knife ionoscloud lan delete LAN_ID [LAN_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 lan delete LAN_ID