knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/contract_list.md

@@ -2,25 +2,30 @@
 
 Lists information about available contract resources.
 
-    knife ionoscloud contract list
-
+```text
+knife ionoscloud contract 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 contract list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud contract list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_create.md

@@ -2,23 +2,26 @@
 
 Unless you are planning to manage an existing Ionoscloud environment, the first step will typically involve choosing the location for a new virtual data centerA list of locations can be obtained with location command.
 
-	knife ionoscloud location list
+	```text
+knife ionoscloud location list
+```
 
 Make a note of the desired location ID and now the data center can be created.
 
 
-    knife ionoscloud datacenter create (options)
-
+```text
+knife ionoscloud datacenter create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * location
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     name: --name NAME, -n NAME
         name of the data center
 
@@ -34,8 +37,12 @@ Make a note of the desired location ID and now the data center can be created.
     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 datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD
+```text
+knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_delete.md

@@ -2,25 +2,30 @@
 
 You will want to exercise a bit of caution here. Removing a data center will destroy all objects contained within that data center -- servers, volumes, snapshots, and so on. The objects -- once removed -- will be unrecoverable.
 
-    knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]
-
+```text
+knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_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 datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_get.md

@@ -0,0 +1,35 @@
+# DatacenterGet
+
+Retrieves information about a Ionoscloud Datacenter.
+
+```text
+knife ionoscloud datacenter get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        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 datacenter get --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_list.md

@@ -2,25 +2,30 @@
 
 Ionoscloud introduces the concept of virtual data centers. These are logically separated from one another and allow you to have a self-contained environment for all servers, volumes, networking, and other resources. The goal is to give you the same experience as you would have if you were running your own physical data center. A list of available data centers can be obtained with the following command.
 
-    knife ionoscloud datacenter list
-
+```text
+knife ionoscloud datacenter 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 datacenter list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud datacenter list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_update.md

@@ -0,0 +1,44 @@
+# DatacenterUpdate
+
+Updates information about a Ionoscloud Datacenter.
+
+```text
+knife ionoscloud datacenter update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION
+        description of the data center
+
+    sec_auth_protection: --sec-auth-protection SEC_AUTH_PROTECTION
+        boolean value representing if the data center requires extra protection e.g. two factor protection
+
+    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 datacenter update --datacenter-id DATACENTER_ID --name NAME --description DESCRIPTION --sec-auth-protection SEC_AUTH_PROTECTION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/firewall_create.md

@@ -2,20 +2,21 @@
 
 Creates a new firewall rule on an existing NIC.
 
-    knife ionoscloud firewall create (options)
-
+```text
+knife ionoscloud firewall create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
-* nic_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the data center (required)
 
@@ -26,7 +27,7 @@ Creates a new firewall rule on an existing NIC.
         iD of the NIC (required)
 
     name: --name NAME, -n NAME
-        name of the NIC
+        name of the Firewall Rule
 
     protocol: --protocol PROTOCOL, -P PROTOCOL
         the protocol of the firewall rule (TCP, UDP, ICMP, ANY)
@@ -58,8 +59,12 @@ Creates a new firewall rule on an existing NIC.
     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 firewall create --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD
+```text
+knife ionoscloud firewall create --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/firewall_delete.md

@@ -2,20 +2,21 @@
 
 Deletes a firewall rule from an existing NIC.
 
-    knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (options)
-
+```text
+knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
-* nic_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         the ID of the data center (required)
 
@@ -31,8 +32,12 @@ Deletes a firewall rule from an existing NIC.
     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 firewall delete FIREWALL_ID 
+```text
+knife ionoscloud firewall delete FIREWALL_ID 
+```

data/docs/subcommands/firewall_get.md

@@ -0,0 +1,47 @@
+# FirewallGet
+
+Retrieves information about a Ionoscloud Firewall Rule.
+
+```text
+knife ionoscloud firewall get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* firewall\_id
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        the ID of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server (required)
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC (required)
+
+    firewall_id: --firewall-id FIREWALL_ID, -F FIREWALL_ID
+        iD of the Firewall 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 firewall get --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --firewall-id FIREWALL_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/firewall_list.md

@@ -2,20 +2,21 @@
 
 Lists all available firewall rules assigned to a NIC.
 
-    knife ionoscloud firewall list (options)
-
+```text
+knife ionoscloud firewall list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
-* server_id
-* nic_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* datacenter\_id
+* server\_id
+* nic\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         iD of the data center (required)
 
@@ -31,8 +32,12 @@ Lists all available firewall rules assigned to a NIC.
     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 firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD
+```text
+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/firewall_update.md

@@ -0,0 +1,71 @@
+# FirewallUpdate
+
+Updates information about a Ionoscloud Firewall Rule.
+
+```text
+knife ionoscloud firewall update (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)
+
+    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
+
+    firewall_id: --firewall-id FIREWALL_ID, -F FIREWALL_ID
+        iD of the Firewall Rule
+
+    name: --name NAME, -n NAME
+        name of the Firewall Rule
+
+    protocol: --protocol PROTOCOL, -P PROTOCOL
+        the protocol of the firewall rule (TCP, UDP, ICMP, ANY)
+
+    source_mac: --source-mac MAC, -m MAC
+        only traffic originating from the respective MAC address is allowed
+
+    source_ip: --source-ip IP, -I IP
+        only traffic originating from the respective IPv4 address is allowed; null allows all source IPs
+
+    target_ip: --target-ip IP
+        in case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed; null value allows all target IPs
+
+    port_range_start: --port-range-start PORT, -p PORT
+        defines the start range of the allowed port(s)
+
+    port_range_end: --port-range-end PORT, -t PORT
+        defines the end range of the allowed port(s)
+
+    icmp_type: --icmp-type INT
+        defines the allowed type (from 0 to 254) if the protocol ICMP is chosen; null allows all types
+
+    icmp_code: --icmp-code INT
+        defines the allowed code (from 0 to 254) if the protocol ICMP is chosen; null allows all codes
+
+    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 firewall update --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --firewall-id FIREWALL_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_create.md

@@ -2,18 +2,19 @@
 
 Use this operation to create a new group and set group privileges.
 
-    knife ionoscloud group create (options)
-
+```text
+knife ionoscloud group create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * name
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     name: --name NAME, -N NAME
         mame of the group. (required)
 
@@ -35,14 +36,27 @@ Use this operation to create a new group and set group privileges.
     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.
+
     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 group create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --username USERNAME --password PASSWORD
+```text
+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 --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_delete.md

@@ -2,25 +2,30 @@
 
 Use this operation to delete a single group. Resources that are assigned to the group are NOT deleted, but are no longer accessible to the group members unless the member is a Contract Owner, Admin, or Resource Owner.
 
-    knife ionoscloud group delete GROUP_ID [GROUP_ID]
-
+```text
+knife ionoscloud group delete GROUP_ID [GROUP_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 group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_get.md

@@ -2,18 +2,19 @@
 
 Retrieves detailed information about a specific group. This will also retrieve a list of users who are members of the group.
 
-    knife ionoscloud group get (options)
-
+```text
+knife ionoscloud group get (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 @@ Retrieves detailed information about a specific group. This will also retrieve a
     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 get --group-id GROUP_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud group get --group-id GROUP_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/group_list.md

@@ -2,17 +2,18 @@
 
 This retrieves a full list of all groups.
 
-    knife ionoscloud group list (options)
-
+```text
+knife ionoscloud group list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     user_id: --user-id USER_ID, -u USER_ID
         iD of the user.
 
@@ -22,8 +23,12 @@ This retrieves a full list of all groups.
     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 list --user-id USER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud group list --user-id USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```