knife-ionoscloud 5.1.1 → 5.1.2

data/docs/subcommands/lan_update.md

@@ -0,0 +1,51 @@
+# LanUpdate
+
+Updates information about a Ionoscloud LAN.
+
+```text
+knife ionoscloud lan update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* lan\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    lan_id: --lan-id LAN_ID, -L LAN_ID
+        iD of the LAN (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    public: --public PUBLIC, -p PUBLIC
+        boolean indicating if the LAN faces the public Internet or not; defaults to false
+
+    pcc: --pcc PCC_ID
+        iD of the PCC to connect the LAN to
+
+    ip_failover: --ip-failover IPFAILOVER [IPFAILOVER]
+        iP failover configurations for lan
+
+    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 lan update --datacenter-id DATACENTER_ID --lan-id LAN_ID --name NAME --public PUBLIC --pcc PCC_ID --ip-failover IPFAILOVER [IPFAILOVER] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/loadbalancer_create.md

@@ -25,7 +25,7 @@ knife ionoscloud loadbalancer create (options)
     ip: --ip IP
         iPv4 address of the load balancer. All attached NICs will inherit this IP.
 
-    dhcp: --dhcp DHCP, -d DHCP
+    dhcp: --dhcp DHCP
         indicates if the load balancer will reserve an IP using DHCP.
 
     nics: --nics NIC_ID [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/nic_create.md

@@ -29,13 +29,13 @@ knife ionoscloud nic create (options)
     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
@@ -51,5 +51,5 @@ knife ionoscloud nic create (options)
 ## Example
 
 ```text
-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 --extra-config EXTRA_CONFIG_FILE_PATH
+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

@@ -20,7 +20,7 @@ knife ionoscloud nic delete NIC_ID [NIC_ID] (options)
         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)

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_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_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/nodepool_create.md

@@ -15,7 +15,7 @@ knife ionoscloud nodepool create (options)
 * datacenter\_id
 * cluster\_id
 * name
-* version
+* k8s\_version
 * node\_count
 * cpu\_family
 * cores
@@ -36,10 +36,10 @@ knife ionoscloud nodepool create (options)
     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
@@ -78,6 +78,12 @@ knife ionoscloud nodepool create (options)
     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)
 
@@ -91,5 +97,5 @@ knife ionoscloud nodepool create (options)
 ## Example
 
 ```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] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+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
 ```

data/docs/subcommands/nodepool_get.md

@@ -0,0 +1,39 @@
+# NodepoolGet
+
+Retrieves the attributes of a given K8S Nodepool.
+
+```text
+knife ionoscloud nodepool get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* 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)
+
+    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
+        the ID of the K8s Nodepool (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 nodepool get --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nodepool_update.md

@@ -0,0 +1,69 @@
+# NodepoolUpdate
+
+Updates information about a Ionoscloud K8s Nodepool.
+
+```text
+knife ionoscloud nodepool update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        iD of the Kubernetes cluster (required)
+
+    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
+        iD of the Kubernetes nodepool (required)
+
+    k8s_version: --version VERSION, -v VERSION
+        the version for the Kubernetes cluster.
+
+    maintenance_day: --maintenance-day 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.
+
+    node_count: --node-count NODE_COUNT, -c NODE_COUNT
+        the number of worker nodes that the node pool should contain. Min 2, Max: Determined by the resource availability.
+
+    min_node_count: --min-node-count MIN_NODE_COUNT
+        the minimum number of worker nodes that the managed node group can scale in
+
+    max_node_count: --max-node-count MAX_NODE_COUNT
+        the maximum number of worker nodes that the managed node pool can scale-out.
+
+    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
+
+```text
+knife ionoscloud nodepool update --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --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
+```

data/docs/subcommands/pcc_get.md

@@ -0,0 +1,35 @@
+# PccGet
+
+Retrieves information about a Ionoscloud Private Cross Connect.
+
+```text
+knife ionoscloud pcc get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* pcc\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
+        iD of the Private Cross Connect (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 pcc get --pcc-id PRIVATE_CROSS_CONNECT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_update.md

@@ -0,0 +1,41 @@
+# PccUpdate
+
+Updates information about a Ionoscloud Private Cross Connect. In order to add LANs to the Private Cross Connect one shouldupdate the LAN and change the pcc property using the ```text\knife ionscloud lan update\n``` command.
+
+```text
+knife ionoscloud pcc update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* pcc\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
+        iD of the Private Cross Connect (required)
+
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION
+        description of the data center
+
+    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 pcc update --pcc-id PRIVATE_CROSS_CONNECT_ID --name NAME --description DESCRIPTION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/request_get.md

@@ -0,0 +1,35 @@
+# RequestGet
+
+Retrieves the properties of a specific request based on the supplied request id.
+
+```text
+knife ionoscloud request get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* request\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    request_id: --request-id REQUEST_ID, -R REQUEST_ID
+        the ID of the Request. (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 request get --request-id REQUEST_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/s3key_get.md

@@ -0,0 +1,39 @@
+# S3keyGet
+
+Retrieves the properties of an S3 Key.
+
+```text
+knife ionoscloud s3key get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* user\_id
+* s3\_key\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    user_id: --user USER_ID, -u USER_ID
+        the ID of the user (required)
+
+    s3_key_id: --s3-key S3KEY_ID, -S S3KEY_ID
+        the ID of the S3 Key. (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 s3key get --user USER_ID --s3-key S3KEY_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/server_get.md

@@ -0,0 +1,39 @@
+# ServerGet
+
+Retrieves the attributes of a given Server.
+
+```text
+knife ionoscloud server get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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)
+
+    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 server get --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```