knife-ionoscloud 6.0.0.alpha.1 → 6.0.0.beta.1

data/docs/subcommands/networkloadbalancer_list.md

@@ -0,0 +1,35 @@
+# NetworkloadbalancerList
+
+Retrieve a list of Network Load Balancers within the datacenter.
+
+```text
+knife ionoscloud networkloadbalancer list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (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 networkloadbalancer list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_rule_add.md

@@ -0,0 +1,72 @@
+# NetworkloadbalancerRuleAdd
+
+Adds a Forwarding Rule to a Network Load Balancer under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* name
+* listener\_ip
+* listener\_port
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (required)
+
+    name: --name NAME, -n NAME
+        a name of that Network Load Balancer forwarding rule (required)
+
+    algorithm: --algorithm ALGORITHM, -a ALGORITHM
+        algorithm for the balancing
+
+    protocol: --protocol PROTOCOL
+        protocol of the balancing
+
+    listener_ip: --ip LISTENER_IP, -i LISTENER_IP
+        listening IP. (inbound) (required)
+
+    listener_port: --port LISTENER_PORT, -p LISTENER_PORT
+        listening port number. (inbound) (range: 1 to 65535) (required)
+
+    client_timeout: --client-timeout CLIENT_TIMEOUT
+        clientTimeout is expressed in milliseconds. This inactivity timeout applies when the client is expected to acknowledge or send data. If unset the default of 50 seconds will be used.
+
+    check_timeout: --check-timeout CLIENT_TIMEOUT
+        it specifies the time (in milliseconds) for a target VM in this pool to answer the check. If a target VM has CheckInterval set and CheckTimeout is set too, then the smaller value of the two is used after the TCP connection is established.
+
+    connect_timeout: --connect-timeout CONNECT_TIMEOUT
+        it specifies the maximum time (in milliseconds) to wait for a connection attempt to a target VM to succeed. If unset, the default of 5 seconds will be used.
+
+    target_timeout: --terget-timeout TARGET_TIMEOUT
+        targetTimeout specifies the maximum inactivity time (in milliseconds) on the target VM side. If unset, the default of 50 seconds will be used.
+
+    retries: --retries RETRIES, -r RETRIES
+        retries specifies the number of retries to perform on a target VM after a connection failure. If unset, the default value of 3 will be used. (valid range: [0, 65535])
+
+    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 networkloadbalancer rule add --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --name NAME --algorithm ALGORITHM --protocol PROTOCOL --ip LISTENER_IP --port LISTENER_PORT --client-timeout CLIENT_TIMEOUT --check-timeout CLIENT_TIMEOUT --connect-timeout CONNECT_TIMEOUT --terget-timeout TARGET_TIMEOUT --retries RETRIES --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_rule_list.md

@@ -0,0 +1,39 @@
+# NetworkloadbalancerRuleList
+
+Lists all available rules in a Network Loadbalancer under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (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 networkloadbalancer rule list --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_rule_remove.md

@@ -0,0 +1,39 @@
+# NetworkloadbalancerRuleRemove
+
+Removes the specified rules from a Network Loadbalancer under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule remove RULE_ID [RULE_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (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 networkloadbalancer rule remove RULE_ID 
+```

data/docs/subcommands/networkloadbalancer_rule_target_add.md

@@ -0,0 +1,64 @@
+# NetworkloadbalancerRuleTargetAdd
+
+Adds a target to a Network Load Balancer Forwarding Rule under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule target add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* forwarding\_rule\_id
+* ip
+* port
+* weight
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Network Loadbalancer Forwarding Rule (required)
+
+    ip: --ip IP, -i IP
+        iP of a balanced target VM (required)
+
+    port: --port PORT, -p PORT
+        port of the balanced target service. (range: 1 to 65535) (required)
+
+    weight: --weight WEIGTH, -w WEIGTH
+        weight parameter is used to adjust the target VM's weight relative to other target VMs. All target VMs will receive a load proportional to their weight relative to the sum of all weights, so the higher the weight, the higher the load. The default weight is 1, and the maximal value is 256. A value of 0 means the target VM will not participate in load-balancing but will still accept persistent connections. If this parameter is used to distribute the load according to target VM's capacity, it is recommended to start with values which can both grow and shrink, for instance between 10 and 100 to leave enough room above and below for later adjustments. (required)
+
+    check: --check, -c
+        check specifies whether the target VM's health is checked. If turned off, a target VM is always considered available. If turned on, the target VM is available when accepting periodic TCP connections, to ensure that it is really able to serve requests. The address and port to send the tests to are those of the target VM. The health check only consists of a connection attempt.
+
+    check_interval: --check-interval CHECK_INTERVAL
+        checkInterval determines the duration (in milliseconds) between consecutive health checks. If unspecified a default of 2000 ms is used.
+
+    maintenance: --maintenance MAINTENANCE, -m
+        maintenance specifies if a target VM should be marked as down, even if it is not.
+
+    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 networkloadbalancer rule target add --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --forwarding-rule FORWARDING_RULE_ID --ip IP --port PORT --weight WEIGTH --check --check-interval CHECK_INTERVAL --maintenance MAINTENANCE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_rule_target_list.md

@@ -0,0 +1,43 @@
+# NetworkloadbalancerRuleTargetList
+
+Lists all targets of a Network Loadbalancer Forwarding Rule under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule target list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* forwarding\_rule\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Network Loadbalancer Forwarding Rule (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 networkloadbalancer rule target list --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --forwarding-rule FORWARDING_RULE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_rule_target_remove.md

@@ -0,0 +1,51 @@
+# NetworkloadbalancerRuleTargetRemove
+
+Adds a target to a Network Load Balancer Forwarding Rule under a data center.
+
+```text
+knife ionoscloud networkloadbalancer rule target remove (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* forwarding\_rule\_id
+* ip
+* port
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    network_loadbalancer_id: --network-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Network Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Network Loadbalancer Forwarding Rule (required)
+
+    ip: --ip IP, -i IP
+        iP of a balanced target VM (required)
+
+    port: --port PORT, -p PORT
+        port of the balanced target service. (range: 1 to 65535) (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 networkloadbalancer rule target remove --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --forwarding-rule FORWARDING_RULE_ID --ip IP --port PORT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nic_create.md

@@ -35,8 +35,8 @@ knife ionoscloud nic create (options)
     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
-        set to enable NAT on the NIC
+    firewall_type: --firewall-type FIREWALL_TYPE, -t FIREWALL_TYPE
+        the type of firewall rules that will be allowed on the NIC. If it is not specified it will take the default value INGRESS
 
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
@@ -44,9 +44,12 @@ knife ionoscloud nic 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 nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD
+knife ionoscloud nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```

data/docs/subcommands/nic_delete.md

@@ -28,6 +28,9 @@ knife ionoscloud nic delete NIC_ID [NIC_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
 

data/docs/subcommands/nic_list.md

@@ -28,9 +28,12 @@ knife ionoscloud nic 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 nic list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
+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/node_delete.md

@@ -28,6 +28,9 @@ knife ionoscloud node delete NODE_ID [NODE_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
 

data/docs/subcommands/node_list.md

@@ -28,9 +28,12 @@ knife ionoscloud node 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 node list--cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD
+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

@@ -30,6 +30,9 @@ knife ionoscloud node replace NODE_ID [NODE_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
 

data/docs/subcommands/nodepool_create.md

@@ -75,15 +75,21 @@ knife ionoscloud nodepool create (options)
     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.
+
     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 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
+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
 ```