knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/loadbalancer_nic_remove.md

@@ -2,19 +2,20 @@
 
 Removes the association of a NIC with a load balancer.
 
-    knife ionoscloud loadbalancer nic remove NIC_ID [NIC_ID] (options)
-
+```text
+knife ionoscloud loadbalancer nic remove NIC_ID [NIC_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* loadbalancer_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -27,8 +28,12 @@ Removes the association of a NIC with a load balancer.
     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 loadbalancer nic remove NIC_ID 
+```text
+knife ionoscloud loadbalancer nic remove NIC_ID 
+```

data/docs/subcommands/loadbalancer_update.md

@@ -0,0 +1,48 @@
+# LoadbalancerUpdate
+
+Updates information about a Ionoscloud Load Balancer.
+
+```text
+knife ionoscloud loadbalancer update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    loadbalancer_id: --loadbalancer-id LOADBALANCER_ID, -L LOADBALANCER_ID
+        iD of the load balancer (required)
+
+    name: --name NAME, -n NAME
+        name of the load balancer
+
+    ip: --ip IP
+        iPv4 address of the load balancer. All attached NICs will inherit this IP.
+
+    dhcp: --dhcp DHCP
+        indicates if the load balancer will reserve an IP using DHCP.
+
+    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 loadbalancer update --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --name NAME --ip IP --dhcp DHCP --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/location_list.md

@@ -2,25 +2,30 @@
 
 List available physical locations where resources can reside.
 
-    knife ionoscloud location list
-
+```text
+knife ionoscloud location 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 location list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud location list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nic_create.md

@@ -1,22 +1,22 @@
 # NicCreate
 
-Creates a NIC on the specified server.
-The Ionoscloud platform supports adding multiple NICs to a server. These NICs can be used to create different, segmented networks on the platform.
-
-    knife ionoscloud nic create (options)
+Creates a NIC on the specified server. The Ionoscloud platform supports adding multiple NICs to a server. These NICs can be used to create different, segmented networks on the platform.
 
+```text
+knife ionoscloud nic create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
+
+* datacenter\_id
+* server\_id
 * lan
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -29,13 +29,13 @@ The Ionoscloud platform supports adding multiple NICs to a server. These NICs ca
     ips: --ips IP[,IP,...], -i IP[,IP,...]
         iPs assigned to the NIC
 
-    dhcp: --dhcp, -d
+    dhcp: --dhcp DHCP
         set to false if you wish to disable DHCP
 
     lan: --lan ID, -l ID
         the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created (required)
 
-    nat: --nat
+    nat: --nat NAT
         set to enable NAT on the NIC
 
     ionoscloud_username: --username USERNAME, -u USERNAME
@@ -44,8 +44,12 @@ The Ionoscloud platform supports adding multiple NICs to a server. These NICs 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 nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD
+```text
+knife ionoscloud nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp DHCP --lan ID --nat NAT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nic_delete.md

@@ -2,24 +2,25 @@
 
 Deletes an existing NIC from a server.
 
-    knife ionoscloud nic delete NIC_ID [NIC_ID] (options)
-
+```text
+knife ionoscloud nic delete NIC_ID [NIC_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)
 
     server_id: --server-id SERVER_ID, -S SERVER_ID
-        the ID of the server assigned the NIC (required)
+        the ID of the server to which the NIC is assigned (required)
 
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
@@ -27,8 +28,12 @@ Deletes an existing NIC from a 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 nic delete NIC_ID 
+```text
+knife ionoscloud nic delete NIC_ID 
+```

data/docs/subcommands/nic_get.md

@@ -0,0 +1,43 @@
+# NicGet
+
+Retrieves the attributes of a given NIC.
+
+```text
+knife ionoscloud nic get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (required)
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the load balancer (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 nic get --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nic_list.md

@@ -2,19 +2,20 @@
 
 List all available NICs connected to a server.
 
-    knife ionoscloud nic list (options)
-
+```text
+knife ionoscloud nic list (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 datacenter containing the NIC (required)
 
@@ -27,8 +28,12 @@ List all available NICs connected to a 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 nic list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud nic list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nic_update.md

@@ -0,0 +1,58 @@
+# NicUpdate
+
+Updates information about a Ionoscloud NIC.
+
+```text
+knife ionoscloud nic update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (required)
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the load balancer (required)
+
+    name: --name NAME, -n NAME
+        name of the NIC
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        iPs assigned to the NIC
+
+    dhcp: --dhcp DHCP
+        set to false if you wish to disable DHCP
+
+    lan: --lan ID, -l ID
+        the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created
+
+    nat: --nat NAT
+        set to enable NAT on the NIC
+
+    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 nic update --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --ips IP[,IP,...] --dhcp DHCP --lan ID --nat NAT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/node_delete.md

@@ -2,19 +2,20 @@
 
 Delete a single Kubernetes Node.
 
-    knife ionoscloud node delete NODE_ID [NODE_ID] (options)
-
+```text
+knife ionoscloud node delete NODE_ID [NODE_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* nodepool_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the K8s Cluster (required)
 
@@ -27,8 +28,12 @@ Delete a single Kubernetes Node.
     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 node delete NODE_ID 
+```text
+knife ionoscloud node delete NODE_ID 
+```

data/docs/subcommands/node_get.md

@@ -0,0 +1,43 @@
+# NodeGet
+
+Retrieves the attributes of a given K8S Node.
+
+```text
+knife ionoscloud node get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* cluster\_id
+* nodepool\_id
+* node\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        the ID of the K8s Cluster (required)
+
+    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
+        the ID of the K8s Nodepool (required)
+
+    node_id: --node-id NODE_ID, -N NODE_ID
+        iD of the load balancer (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 node get --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --node-id NODE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/node_list.md

@@ -2,19 +2,20 @@
 
 Retrieve a list of Kubernetes Nodes in a Nodepool.
 
-    knife ionoscloud node list
-
+```text
+knife ionoscloud node list
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* nodepool_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the K8s Cluster (required)
 
@@ -27,8 +28,12 @@ Retrieve a list of Kubernetes Nodes in a Nodepool.
     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 node list--cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud node list--cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/node_replace.md

@@ -2,21 +2,22 @@
 
 You can recreate a single Kubernetes Node.
 
-Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
-
-    knife ionoscloud node replace NODE_ID [NODE_ID] (options)
+Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
 
+```text
+knife ionoscloud node replace NODE_ID [NODE_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* nodepool_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the K8s Cluster (required)
 
@@ -29,8 +30,12 @@ Managed Kubernetes starts a process which based on the nodepool's template c
     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 node replace NODE_ID 
+```text
+knife ionoscloud node replace NODE_ID 
+```

data/docs/subcommands/nodepool_create.md

@@ -1,31 +1,32 @@
 # NodepoolCreate
 
-Creates a node pool into an existing Kubernetes cluster. The Kubernetes cluster must be in state "ACTIVE" before creating a node pool.
+Creates a node pool into an existing Kubernetes cluster. The Kubernetes cluster must be in state "ACTIVE" before creating a node pool.
 
 The worker nodes within the node pools will be deployed into an existing data centers.
 
-    knife ionoscloud nodepool create (options)
-
+```text
+knife ionoscloud nodepool create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* cluster_id
+
+* datacenter\_id
+* cluster\_id
 * name
-* version
-* node_count
-* cpu_family
+* k8s\_version
+* node\_count
+* cpu\_family
 * cores
 * ram
-* availability_zone
-* storage_type
-* storage_size
-* ionoscloud_username
-* ionoscloud_password
+* availability\_zone
+* storage\_type
+* storage\_size
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the virtual datacenter (required)
 
@@ -35,10 +36,10 @@ The worker nodes within the node pools will be deployed into an existing data ce
     name: --name NAME, -n NAME
         name of the Kubernetes node pool (required)
 
-    version: --version VERSION, -v VERSION
-        the version for the Kubernetes cluster. (required)
+    k8s_version: --version VERSION, -v VERSION
+        the version for the Kubernetes Nodepool. (required)
 
-    maintenance_day: --maintenance-day MAINTENANCE_DAY, -d MAINTENANCE_DAY
+    maintenance_day: --maintenance-day MAINTENANCE_DAY
         day Of the week when to perform the maintenance.
 
     maintenance_time: --maintenance-time MAINTENANCE_TIME, -t MAINTENANCE_TIME
@@ -74,14 +75,27 @@ The worker nodes within the node pools will be deployed into an existing data ce
     lans: --lans LAN_ID [LAN_ID]
         an array of additional private LANs attached to worker nodes
 
+    public_ips: --ips PUBLIC_IP [PUBLIC_IP]
+        optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.
+
+    labels: --labels LABEL [LABEL]
+        map of labels attached to node pool
+
+    annotations: --annotations ANNOTATION [ANNOTATION]
+        map of annotations attached to node pool
+
     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 nodepool create --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --username USERNAME --password PASSWORD
+```text
+knife ionoscloud nodepool create --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --ips PUBLIC_IP [PUBLIC_IP] --labels LABEL [LABEL] --annotations ANNOTATION [ANNOTATION] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```