knife-ionoscloud 5.0.0 → 6.0.0.beta.1

data/docs/subcommands/firewall_list.md

@@ -31,11 +31,13 @@ knife ionoscloud firewall list (options)
 
     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 firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD
+knife ionoscloud firewall list --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/flowlog_create.md

@@ -0,0 +1,63 @@
+# FlowlogCreate
+
+This will add a Flow Log to the network interface, NAT Gateway or Network Load Balancer.
+
+```text
+knife ionoscloud flowlog create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* type
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    type: --type FLOWLOG_TYPE, -t FLOWLOG_TYPE
+        the object to which the flow log will be attached (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        iD of the server
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC
+
+    natgateway_id: --natgateway NAT_GATEWAY_ID, -G NAT_GATEWAY_ID
+        iD of the NAT Gateway
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER, -L NETWORK_LOADBALANCER
+        iD of the Network Load Balancer
+
+    name: --name NAME, -n NAME
+        name of the Flow Log
+
+    action: --action ACTION, -a ACTION
+        specifies the traffic action pattern. Must be one of ["ALL", "ACCEPTED", "REJECTED"].
+
+    direction: --direction DIRECTION
+        specifies the traffic direction pattern. Must be one of ["INGRESS", "EGRESS", "BIDIRECTIONAL"].
+
+    bucket: --bucket BUCKET, -b BUCKET
+        s3 bucket name of an existing IONOS Cloud S3 bucket. Ex. bucketName/key
+
+    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 flowlog create --datacenter-id DATACENTER_ID --type FLOWLOG_TYPE --server-id SERVER_ID --nic-id NIC_ID --natgateway NAT_GATEWAY_ID --network-loadbalancer NETWORK_LOADBALANCER --name NAME --action ACTION --direction DIRECTION --bucket BUCKET --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/flowlog_delete.md

@@ -0,0 +1,51 @@
+# FlowlogDelete
+
+Removes the specified Flow Logs.
+
+```text
+knife ionoscloud flowlog delete FLOWLOG_ID [FLOWLOG_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* type
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    type: --type FLOWLOG_TYPE, -t FLOWLOG_TYPE
+        the object to which the flow log will be attached (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC
+
+    natgateway_id: --nat-gateway NAT_GATEWAY_ID, -G NAT_GATEWAY_ID
+        iD of the NAT Gateway
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER, -L NETWORK_LOADBALANCER
+        iD of the Network Load Balancer
+
+    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 flowlog delete FLOWLOG_ID 
+```

data/docs/subcommands/flowlog_list.md

@@ -0,0 +1,51 @@
+# FlowlogList
+
+Lists all available flow logs assigned to a NIC, NAT Gateway or Network Load Balancer.
+
+```text
+knife ionoscloud flowlog list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* type
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    type: --type FLOWLOG_TYPE, -t FLOWLOG_TYPE
+        the object to which the flow log will be attached (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC
+
+    natgateway_id: --nat-gateway NAT_GATEWAY_ID, -G NAT_GATEWAY_ID
+        iD of the NAT Gateway
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER, -L NETWORK_LOADBALANCER
+        iD of the Network Load Balancer
+
+    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 flowlog list --datacenter-id DATACENTER_ID --type FLOWLOG_TYPE --server-id SERVER_ID --nic-id NIC_ID --nat-gateway NAT_GATEWAY_ID --network-loadbalancer NETWORK_LOADBALANCER --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_create.md

@@ -36,16 +36,36 @@ knife ionoscloud group create (options)
     create_backup_unit: --create-backupunit, -b
         the group will be able to manage backup units.
 
+    create_k8s_cluster: --create-k8s-cluster
+        the group will be able to create kubernetes clusters.
+
+    create_pcc: --create-pcc
+        the group will be able to manage pccs.
+
+    create_internet_access: --create-internet-access
+        the group will be have internet access privilege.
+
+    create_flow_log: --create-flow-log
+        the group will be granted create Flow Logs privilege.
+
+    access_and_manage_monitoring: --manage-monitoring
+        privilege for a group to access and manage monitoring related functionality (access metrics, CRUD on alarms, alarm-actions etc) using Monotoring-as-a-Service (MaaS).
+
+    access_and_manage_certificates: --manage-certificates
+        privilege for a group to access and manage certificates.
+
     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 create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --username USERNAME --password PASSWORD
+knife ionoscloud group create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --create-k8s-cluster --create-pcc --create-internet-access --create-flow-log --manage-monitoring --manage-certificates --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/group_delete.md

@@ -19,11 +19,13 @@ knife ionoscloud group delete GROUP_ID [GROUP_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
 
 ```text
-knife ionoscloud group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD
+knife ionoscloud group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/group_get.md

@@ -23,11 +23,13 @@ knife ionoscloud group get (options)
 
     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 get --group-id GROUP_ID --username USERNAME --password PASSWORD
+knife ionoscloud group get --group-id GROUP_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/group_list.md

@@ -22,11 +22,13 @@ knife ionoscloud group list (options)
 
     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 list --user-id USER_ID --username USERNAME --password PASSWORD
+knife ionoscloud group list --user-id USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/group_user_add.md

@@ -23,11 +23,13 @@ knife ionoscloud group user add USER_ID [USER_ID] (options)
 
     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 user add USER_ID 
 ```
-

data/docs/subcommands/group_user_remove.md

@@ -23,11 +23,13 @@ knife ionoscloud group user remove USER_ID [USER_ID] (options)
 
     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 user remove USER_ID 
 ```
-

data/docs/subcommands/image_list.md

@@ -19,11 +19,13 @@ knife ionoscloud image list
 
     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 image list--username USERNAME --password PASSWORD
+knife ionoscloud image list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/ipblock_create.md

@@ -30,11 +30,13 @@ knife ionoscloud ipblock create (options)
 
     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 create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD
+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

@@ -19,11 +19,13 @@ knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_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
 
 ```text
-knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD
+knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/ipblock_list.md

@@ -19,11 +19,13 @@ knife ionoscloud ipblock list
 
     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 list--username USERNAME --password PASSWORD
+knife ionoscloud ipblock list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/ipfailover_add.md

@@ -1,11 +1,11 @@
 # 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.
 
+
 ```text
 knife ionoscloud ipfailover add (options)
 ```
@@ -39,11 +39,13 @@ knife ionoscloud ipfailover add (options)
 
     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 ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
+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

@@ -35,11 +35,13 @@ knife ionoscloud ipfailover remove (options)
 
     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 ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
+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

@@ -21,6 +21,12 @@ knife ionoscloud k8s create (options)
     version: --version VERSION, -v VERSION
         the version for the Kubernetes cluster.
 
+    private: --private
+        the indicator if the cluster is public or private. Be aware that setting it to false is currently in beta phase.
+
+    gateway_ip: --gateway GATEWAY_IP
+        the IP address of the gateway used by the cluster. This is mandatory when `public` is set to `false` and should not be provided otherwise.
+
     maintenance_day: --maintenance-day MAINTENANCE_DAY, -d MAINTENANCE_DAY
         day Of the week when to perform the maintenance.
 
@@ -32,11 +38,13 @@ knife ionoscloud k8s create (options)
 
     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 create --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD
+knife ionoscloud k8s create --name NAME --version VERSION --private --gateway GATEWAY_IP --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-