knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/k8s_update.md

@@ -0,0 +1,53 @@
+# K8sUpdate
+
+Updates information about a Ionoscloud K8s Cluster.
+
+```text
+knife ionoscloud k8s update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* cluster\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        iD of the Kubernetes cluster (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    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.
+
+    api_subnet_allow_list: --subnets SUBNET[,SUBNET,...]
+        access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.
+
+    s3_buckets: --s3-buckets BUCKET[,BUCKET,...]
+        list of S3 bucket configured for K8s usage. For now it contains only one S3 bucket used to store K8s API audit logs.
+
+    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 k8s update --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --subnets SUBNET[,SUBNET,...] --s3-buckets BUCKET[,BUCKET,...] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/kubeconfig_get.md

@@ -2,18 +2,19 @@
 
 Retrieve the kubeconfig file for a given Kubernetes cluster.
 
-    knife ionoscloud kubeconfig get (options)
-
+```text
+knife ionoscloud kubeconfig get (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the Kubernetes cluster. (required)
 
@@ -23,8 +24,12 @@ Retrieve the kubeconfig file for a given Kubernetes cluster.
     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 kubeconfig get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud kubeconfig get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/label_add.md

@@ -2,21 +2,22 @@
 
 Add a Label to a Resource.
 
-    knife ionoscloud label add (options)
-
+```text
+knife ionoscloud label add (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * type
-* resource_id
+* resource\_id
 * key
 * value
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     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)
 
@@ -38,8 +39,12 @@ Add a Label to a Resource.
     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 label add --resource-type RESOURCE_TYPE --key KEY --value VALUE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud label add --resource-type RESOURCE_TYPE --key KEY --value VALUE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/label_list.md

@@ -2,17 +2,18 @@
 
 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)
-
+```text
+knife ionoscloud label list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
         type of the resource to be labeled.
 
@@ -28,8 +29,12 @@ List all Labels available to the user. Specify the type and required resource ID
     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 label list --resource-type RESOURCE_TYPE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud label list --resource-type RESOURCE_TYPE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/label_remove.md

@@ -2,19 +2,20 @@
 
 Remove a Label from a Resource.
 
-    knife ionoscloud label remove LABEL_KEY [LABEL_KEY] (options)
-
+```text
+knife ionoscloud label remove LABEL_KEY [LABEL_KEY] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * type
-* resource_id
-* ionoscloud_username
-* ionoscloud_password
+* resource\_id
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
         type of the resource to be labeled. (required)
 
@@ -30,8 +31,12 @@ Remove a Label from a Resource.
     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 label remove LABEL_KEY 
+```text
+knife ionoscloud label remove LABEL_KEY 
+```

data/docs/subcommands/lan_create.md

@@ -2,18 +2,19 @@
 
 Creates a new LAN under a data center.
 
-    knife ionoscloud lan create (options)
-
+```text
+knife ionoscloud lan create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -23,14 +24,21 @@ Creates a new LAN under a data center.
     public: --public, -p
         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
+
     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 lan create --datacenter-id DATACENTER_ID --name NAME --public --username USERNAME --password PASSWORD
+```text
+knife ionoscloud lan create --datacenter-id DATACENTER_ID --name NAME --public --pcc PCC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/lan_delete.md

@@ -2,18 +2,19 @@
 
 Deletes an existing LAN.
 
-    knife ionoscloud lan delete LAN_ID [LAN_ID] (options)
-
+```text
+knife ionoscloud lan delete LAN_ID [LAN_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -23,8 +24,12 @@ Deletes an existing LAN.
     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 lan delete LAN_ID 
+```text
+knife ionoscloud lan delete LAN_ID 
+```

data/docs/subcommands/lan_get.md

@@ -0,0 +1,39 @@
+# LanGet
+
+Retrieves information about a Ionoscloud LAN.
+
+```text
+knife ionoscloud lan get (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)
+
+    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 get --datacenter-id DATACENTER_ID --lan-id LAN_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/lan_list.md

@@ -2,18 +2,19 @@
 
 Lists all available LANs under a data center.
 
-    knife ionoscloud lan list (options)
-
+```text
+knife ionoscloud lan list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         the ID of the data center (required)
 
@@ -23,8 +24,12 @@ Lists all available LANs under a data center.
     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 lan list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud lan list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

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

@@ -2,19 +2,20 @@
 
 Creates a load balancer within the VDC. Load balancers can be used for public or private IP traffic.
 
-    knife ionoscloud loadbalancer create (options)
-
+```text
+knife ionoscloud loadbalancer create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
+
+* datacenter\_id
 * name
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -24,7 +25,7 @@ Creates a load balancer within the VDC. Load balancers can be used for public or
     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]
@@ -36,8 +37,12 @@ Creates a load balancer within the VDC. Load balancers can be used for public or
     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 create --datacenter-id DATACENTER_ID --name NAME --ip IP --dhcp DHCP --nics NIC_ID [NIC_ID] --username USERNAME --password PASSWORD
+```text
+knife ionoscloud loadbalancer create --datacenter-id DATACENTER_ID --name NAME --ip IP --dhcp DHCP --nics NIC_ID [NIC_ID] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/loadbalancer_delete.md

@@ -2,18 +2,19 @@
 
 Deletes the specified load balancer.
 
-    knife ionoscloud loadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
-
+```text
+knife ionoscloud loadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -23,8 +24,12 @@ Deletes the specified 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 delete LOAD_BALANCER_ID 
+```text
+knife ionoscloud loadbalancer delete LOAD_BALANCER_ID 
+```

data/docs/subcommands/loadbalancer_get.md

@@ -2,19 +2,20 @@
 
 Retrieves the attributes of a given load balancer. This will also retrieve a list of NICs associated with the load balancer.
 
-    knife ionoscloud loadbalancer get (options)
-
+```text
+knife ionoscloud loadbalancer get (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
         iD of the data center (required)
 
@@ -27,8 +28,12 @@ Retrieves the attributes of a given load balancer. This will also retrieve a lis
     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 get --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud loadbalancer get --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/loadbalancer_list.md

@@ -2,18 +2,19 @@
 
 Retrieve a list of load balancers within the virtual data center.
 
-    knife ionoscloud loadbalancer list (options)
-
+```text
+knife ionoscloud loadbalancer list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -23,8 +24,12 @@ Retrieve a list of load balancers within the virtual data center.
     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 list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud loadbalancer list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/loadbalancer_nic_add.md

@@ -2,19 +2,20 @@
 
 Adds the association of a NIC with a load balancer.
 
-    knife ionoscloud loadbalancer nic add NIC_ID [NIC_ID] (options)
-
+```text
+knife ionoscloud loadbalancer nic add 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 @@ Adds 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 add NIC_ID 
+```text
+knife ionoscloud loadbalancer nic add NIC_ID 
+```