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

data/docs/subcommands/loadbalancer_nic_remove.md

@@ -28,6 +28,9 @@ knife ionoscloud loadbalancer nic remove 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/location_list.md

@@ -20,9 +20,12 @@ knife ionoscloud location 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 location list--username USERNAME --password PASSWORD
+knife ionoscloud location list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```

data/docs/subcommands/natgateway_create.md

@@ -0,0 +1,41 @@
+# NatgatewayCreate
+
+Creates a new Nat Gateway under a data center.
+
+```text
+knife ionoscloud natgateway create (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)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        iPs assigned to 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 natgateway create --datacenter-id DATACENTER_ID --name NAME --ips IP[,IP,...] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/natgateway_delete.md

@@ -0,0 +1,35 @@
+# NatgatewayDelete
+
+Deletes an existing NAT Gateway.
+
+```text
+knife ionoscloud natgateway delete NATGATEWAY_ID [NATGATEWAY_ID] (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 natgateway delete NATGATEWAY_ID 
+```

data/docs/subcommands/natgateway_lan_add.md

@@ -0,0 +1,46 @@
+# NatgatewayLanAdd
+
+Adds a LAN to a Nat Gateway under a data center.
+
+```text
+knife ionoscloud natgateway lan add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* lan\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway (required)
+
+    lan_id: --lan LAN_ID, -L LAN_ID
+        iD of the LAN (required)
+
+    gateway_ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of gateway IP addresses of the NAT gateway. Will be auto-generated if not provided. Should ideally be an IP belonging to the same subnet as the 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 natgateway lan add --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --lan LAN_ID --ips IP[,IP,...] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/natgateway_lan_remove.md

@@ -0,0 +1,39 @@
+# NatgatewayLanRemove
+
+Removes the specified LANS from a Nat Gateway under a data center.
+
+```text
+knife ionoscloud natgateway lan remove LAN_ID [LAN_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway (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 natgateway lan remove LAN_ID 
+```

data/docs/subcommands/natgateway_list.md

@@ -0,0 +1,35 @@
+# NatgatewayList
+
+Lists all available NAT Gateways under a data center.
+
+```text
+knife ionoscloud natgateway list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID 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 natgateway list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/natgateway_rule_add.md

@@ -0,0 +1,66 @@
+# NatgatewayRuleAdd
+
+Adds a LAN to a Nat Gateway under a data center.
+
+```text
+knife ionoscloud natgateway rule add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* name
+* source\_subnet
+* public\_ip
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway (required)
+
+    name: --name NAME, -n NAME
+        name of the NAT gateway rule (required)
+
+    type: --type TYPE, -t TYPE
+        type of the NAT gateway rule
+
+    protocol: --protocol PROTOCOL, -p PROTOCOL
+        protocol of the NAT gateway rule. Defaults to ALL. If protocol is 'ICMP' then target_port_range start and end cannot be set.
+
+    source_subnet: --source SOURCE_SUBNET
+        source subnet of the NAT gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets source IP address. (required)
+
+    public_ip: --ip PUBLIC_IP, -i PUBLIC_IP
+        public IP address of the NAT gateway rule. Specifies the address used for masking outgoing packets source address field. Should be one of the customer reserved IP address already configured on the NAT gateway resource (required)
+
+    target_subnet: --target TARGET_SUBNET
+        target or destination subnet of the NAT gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets destination IP address. If none is provided, rule will match any address
+
+    target_port_range_start: --port-start PORT_RANGE_START
+        target port range start associated with the NAT gateway rule
+
+    target_port_range_end: --port-end PORT_RANGE_START
+        target port range end associated with the NAT gateway rule
+
+    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 natgateway rule add --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --name NAME --type TYPE --protocol PROTOCOL --source SOURCE_SUBNET --ip PUBLIC_IP --target TARGET_SUBNET --port-start PORT_RANGE_START --port-end PORT_RANGE_START --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/natgateway_rule_list.md

@@ -0,0 +1,38 @@
+# NatgatewayRuleList
+
+Lists all available rules in a NAT Gateways under a data center.
+
+```text
+knife ionoscloud natgateway rule list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway
+
+    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 natgateway rule list --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/natgateway_rule_remove.md

@@ -0,0 +1,39 @@
+# NatgatewayRuleRemove
+
+Removes the specified rules from a Nat Gateway under a data center.
+
+```text
+knife ionoscloud natgateway rule remove RULE_ID [RULE_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway (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 natgateway rule remove RULE_ID 
+```

data/docs/subcommands/networkloadbalancer_create.md

@@ -0,0 +1,54 @@
+# NetworkloadbalancerCreate
+
+Creates an Network Load Balancer within the datacenter.
+
+```text
+knife ionoscloud networkloadbalancer create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* name
+* listener\_lan
+* target\_lan
+* ips
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    name: --name NAME, -n NAME
+        name of the load balancer (required)
+
+    listener_lan: --listener-lan LISTENER_LAN_ID, -l LISTENER_LAN_ID
+        id of the listening LAN. (inbound) (required)
+
+    target_lan: --target-lan TARGET_LAN_ID, -t TARGET_LAN_ID
+        id of the balanced private target LAN. (outbound) (required)
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of IP addresses of the Network Load Balancer. (inbound and outbound) IP of the listenerLan must be a customer reserved IP for the public load balancer and private IP for the private load balancer. (required)
+
+    lb_private_ips: --private-ips IP[,IP,...]
+        collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain valid subnet mask. If user will not provide any IP then the system will generate one IP with /24 subnet.
+
+    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 create --datacenter-id DATACENTER_ID --name NAME --listener-lan LISTENER_LAN_ID --target-lan TARGET_LAN_ID --ips IP[,IP,...] --private-ips IP[,IP,...] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/networkloadbalancer_delete.md

@@ -0,0 +1,35 @@
+# NetworkloadbalancerDelete
+
+Removes the specified Network Load Balancer.
+
+```text
+knife ionoscloud networkloadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (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 delete LOAD_BALANCER_ID 
+```