knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/group_update.md

@@ -0,0 +1,65 @@
+# GroupUpdate
+
+Updates information about a Ionoscloud Group.
+
+```text
+knife ionoscloud group update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* group\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    group_id: --group-id GROUP_ID, -G GROUP_ID
+        iD of the group. (required)
+
+    name: --name NAME, -N NAME
+        mame of the group.
+
+    create_data_center: --create-datacenter CREATE_DATACENTER, -D CREATE_DATACENTER
+        the group will be allowed to create virtual data centers.
+
+    create_snapshot: --create-snapshot CREATE_SNAPSHOT, -s CREATE_SNAPSHOT
+        the group will be allowed to create snapshots.
+
+    reserve_ip: --reserve-ip RESERVE_IP, -i RESERVE_IP
+        the group will be allowed to reserve IP addresses.
+
+    access_activity_log: --access-log ACCESS_ACTIVITY_LOG, -a ACCESS_ACTIVITY_LOG
+        the group will be allowed to access the activity log.
+
+    s3_privilege: --s3 S3_PRIVILEGE
+        the group will be allowed to manage S3
+
+    create_backup_unit: --create-backupunit CREATE_BACKUPUNIT, -b CREATE_BACKUPUNIT
+        the group will be able to manage backup units.
+
+    create_k8s_cluster: --create-k8s-cluster CREATE_K8S_CLUSTER
+        the group will be able to create kubernetes clusters.
+
+    create_pcc: --create-pcc CREATE_PCC
+        the group will be able to manage pccs.
+
+    create_internet_access: --create-internet-access CREATE_INTERNET_ACCESS
+        the group will be have internet access privilege.
+
+    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 group update --group-id GROUP_ID --name NAME --create-datacenter CREATE_DATACENTER --create-snapshot CREATE_SNAPSHOT --reserve-ip RESERVE_IP --access-log ACCESS_ACTIVITY_LOG --s3 S3_PRIVILEGE --create-backupunit CREATE_BACKUPUNIT --create-k8s-cluster CREATE_K8S_CLUSTER --create-pcc CREATE_PCC --create-internet-access CREATE_INTERNET_ACCESS --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_user_add.md

@@ -2,18 +2,19 @@
 
 Use this operation to add an existing user to a group.
 
-    knife ionoscloud group user add USER_ID [USER_ID] (options)
-
+```text
+knife ionoscloud group user add USER_ID [USER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* group_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* group\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -G GROUP_ID
         iD of the group. (required)
 
@@ -23,8 +24,12 @@ Use this operation to add an existing user to a group.
     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 group user add USER_ID 
+```text
+knife ionoscloud group user add USER_ID 
+```

data/docs/subcommands/group_user_remove.md

@@ -2,18 +2,19 @@
 
 Use this operation to remove a user from a group.
 
-    knife ionoscloud group user remove USER_ID [USER_ID] (options)
-
+```text
+knife ionoscloud group user remove USER_ID [USER_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* group_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* group\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     group_id: --group-id GROUP_ID, -G GROUP_ID
         iD of the group. (required)
 
@@ -23,8 +24,12 @@ Use this operation to remove a user from a group.
     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 group user remove USER_ID 
+```text
+knife ionoscloud group user remove USER_ID 
+```

data/docs/subcommands/image_list.md

@@ -2,25 +2,30 @@
 
 A list of disk and ISO images are available from Ionoscloud for immediate use. Make sure the image you use is in the same location as the virtual data center.
 
-    knife ionoscloud image list
-
+```text
+knife ionoscloud image 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 image list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud image list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipblock_create.md

@@ -1,20 +1,21 @@
 # IpblockCreate
 
-Reserves an IP block at a specified location that can be used by resources within any VDCs provisioned in that same location. An IP block consists of one or more static IP addresses. The IP block size (number of IP addresses) and location are required to reserve an IP block.
-
-    knife ionoscloud ipblock create (options)
+Reserves an IP block at a specified location that can be used by resources within any VDCs provisioned in that same location. An IP block consists of one or more static IP addresses. The IP block size \(number of IP addresses\) and location are required to reserve an IP block.
 
+```text
+knife ionoscloud ipblock create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * size
 * location
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     location: --location LOCATION, -l LOCATION
         location of the IP block (us/las, us/ewr, de/fra, de/fkb) (required)
 
@@ -30,8 +31,12 @@ Reserves an IP block at a specified location that can be used by resources withi
     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 ipblock create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD
+```text
+knife ionoscloud ipblock create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipblock_delete.md

@@ -2,25 +2,30 @@
 
 Releases a currently assigned IP block.
 
-    knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]
-
+```text
+knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]
+```
 
 ## 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 ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipblock_get.md

@@ -0,0 +1,35 @@
+# IpblockGet
+
+Retrieves information about an IP Block.
+
+```text
+knife ionoscloud ipblock get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* ipblock\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ipblock_id: --ipblock-id IPBLOCK_ID, -I IPBLOCK_ID
+        iD of the IPBlock. (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 ipblock get --ipblock-id IPBLOCK_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipblock_list.md

@@ -2,25 +2,30 @@
 
 Lists all available IP blocks.
 
-    knife ionoscloud ipblock list
-
+```text
+knife ionoscloud ipblock 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 ipblock list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud ipblock list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipblock_update.md

@@ -0,0 +1,38 @@
+# IpblockUpdate
+
+Updates information about an IP Block.
+
+```text
+knife ionoscloud ipblock update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* ipblock\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ipblock_id: --ipblock-id IPBLOCK_ID, -I IPBLOCK_ID
+        iD of the IPBlock. (required)
+
+    name: --name NAME, -n NAME
+        name of the IP block
+
+    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 ipblock update --ipblock-id IPBLOCK_ID --name NAME --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipfailover_add.md

@@ -6,21 +6,22 @@ Successfully setting up an IP Failover group requires three steps:
 * 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)
-
+```text
+knife ionoscloud ipfailover add (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* lan_id
+
+* datacenter\_id
+* lan\_id
 * ip
-* nic_id
-* ionoscloud_username
-* ionoscloud_password
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -39,8 +40,12 @@ Successfully setting up an IP Failover group requires three steps:
     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 ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/ipfailover_remove.md

@@ -2,21 +2,22 @@
 
 Remove IP Failover from LAN
 
-    knife ionoscloud ipfailover remove (options)
-
+```text
+knife ionoscloud ipfailover remove (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* lan_id
+
+* datacenter\_id
+* lan\_id
 * ip
-* nic_id
-* ionoscloud_username
-* ionoscloud_password
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the data center (required)
 
@@ -35,8 +36,12 @@ Remove IP Failover from 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 ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/k8s_create.md

@@ -2,38 +2,52 @@
 
 Creates a new Managed Kubernetes cluster.
 
-    knife ionoscloud k8s create (options)
-
+```text
+knife ionoscloud k8s create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * name
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     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
+    private: --private
+        the indicator if the cluster is public or private. Be aware that setting it to false is currently in beta phase.
+
+    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
 
-    knife ionoscloud k8s create --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD
+```text
+knife ionoscloud k8s create --name NAME --version VERSION --private --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/k8s_delete.md

@@ -2,25 +2,30 @@
 
 Deletes a Kubernetes cluster. The cluster cannot contain any node pools when deleting.
 
-    knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_ID]
-
+```text
+knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_ID]
+```
 
 ## 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 k8s delete CLUSTER_ID [CLUSTER_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/k8s_get.md

@@ -0,0 +1,35 @@
+# K8sGet
+
+Retrieves information about a K8s Cluster.
+
+```text
+knife ionoscloud k8s get (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)
+
+    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 get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/k8s_list.md

@@ -2,25 +2,30 @@
 
 Retrieve a list of Kubernetes clusters.
 
-    knife ionoscloud k8s list
-
+```text
+knife ionoscloud k8s 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 k8s list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud k8s list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```