knife-ionoscloud 6.0.0.alpha.1 → 6.1.0

data/docs/subcommands/compute-engine/natgateway_lan_add.md

@@ -0,0 +1,49 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway lan add --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --lan LAN_ID --ips IP[,IP,...] --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/natgateway_lan_remove.md

@@ -0,0 +1,42 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway lan remove LAN_ID 
+```

data/docs/subcommands/compute-engine/natgateway_list.md

@@ -0,0 +1,38 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/natgateway_rule_add.md

@@ -0,0 +1,69 @@
+# NatgatewayRuleAdd
+
+Adds a Rule 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway rule add --extra-config EXTRA_CONFIG_FILE_PATH --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 --url URL
+```

data/docs/subcommands/compute-engine/natgateway_rule_list.md

@@ -0,0 +1,41 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway rule list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/natgateway_rule_remove.md

@@ -0,0 +1,42 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway rule remove RULE_ID 
+```

data/docs/subcommands/compute-engine/natgateway_rule_update.md

@@ -0,0 +1,69 @@
+# NatgatewayRuleUpdate
+
+Updates information about a Ionoscloud NAT Gateway.
+
+```text
+knife ionoscloud natgateway rule update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    natgateway_id: --natgateway-id NATGATEWAY_ID, -G NATGATEWAY_ID
+        iD of the NAT Gateway (required)
+
+    natgateway_rule_id: --rule-id RULE_ID, -R RULE_ID
+        iD of the NAT Gateway Rule
+
+    name: --name NAME, -n NAME
+        name of the NAT gateway rule
+
+    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.
+
+    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
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway rule update --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --rule-id RULE_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 --url URL
+```

data/docs/subcommands/compute-engine/natgateway_update.md

@@ -0,0 +1,51 @@
+# NatgatewayUpdate
+
+Updates information about a Ionoscloud NAT Gateway.
+
+```text
+knife ionoscloud natgateway update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* natgateway\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD 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
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of public IP addresses of the NAT gateway. Should be customer reserved IP addresses in that location
+
+    lans: --lans LAN[,LAN,...]
+        collection of LANs connected to the NAT gateway. IPs must contain valid subnet mask. If user will not provide any IP then system will generate an IP with /24 subnet.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud natgateway update --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --natgateway-id NATGATEWAY_ID --name NAME --ips IP[,IP,...] --lans LAN[,LAN,...] --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/networkloadbalancer_create.md

@@ -0,0 +1,57 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud networkloadbalancer create --extra-config EXTRA_CONFIG_FILE_PATH --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 --url URL
+```

data/docs/subcommands/compute-engine/networkloadbalancer_delete.md

@@ -0,0 +1,38 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud networkloadbalancer delete LOAD_BALANCER_ID 
+```

data/docs/subcommands/compute-engine/networkloadbalancer_get.md

@@ -0,0 +1,42 @@
+# NetworkloadbalancerGet
+
+Retrieves the attributes of a given Network Load Balancer.
+
+```text
+knife ionoscloud networkloadbalancer get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* network\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud networkloadbalancer get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --network-loadbalancer NETWORK_LOADBALANCER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/networkloadbalancer_list.md

@@ -0,0 +1,38 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud networkloadbalancer list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/compute-engine/networkloadbalancer_rule_add.md

@@ -0,0 +1,75 @@
+# 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
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    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.
+
+    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])
+
+    targets: --targets TARGETS
+        array of targets
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+```
+## Example
+
+```text
+knife ionoscloud networkloadbalancer rule add --extra-config EXTRA_CONFIG_FILE_PATH --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 --connect-timeout CONNECT_TIMEOUT --terget-timeout TARGET_TIMEOUT --retries RETRIES --targets TARGETS --username USERNAME --password PASSWORD --url URL
+```