knife-ionoscloud 6.0.0.alpha.1 → 6.1.0

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

@@ -0,0 +1,44 @@
+# PccUpdate
+
+Updates information about a Ionoscloud Private Cross Connect. In order to add LANs to the Private Cross Connect one shouldupdate the LAN and change the pcc property using the ```text\knife ionscloud lan update\n``` command.
+
+```text
+knife ionoscloud pcc update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* pcc\_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
+
+    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
+        iD of the Private Cross Connect (required)
+
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION
+        description of the data center
+
+    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 pcc update --extra-config EXTRA_CONFIG_FILE_PATH --pcc-id PRIVATE_CROSS_CONNECT_ID --name NAME --description DESCRIPTION --username USERNAME --password PASSWORD --url URL
+```

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

@@ -0,0 +1,38 @@
+# RequestGet
+
+Retrieves the properties of a specific request based on the supplied request id.
+
+```text
+knife ionoscloud request get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* request\_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
+
+    request_id: --request-id REQUEST_ID, -R REQUEST_ID
+        the ID of the Request. (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 request get --extra-config EXTRA_CONFIG_FILE_PATH --request-id REQUEST_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/{request_list.md → compute-engine/request_list.md}

@@ -14,6 +14,9 @@ knife ionoscloud request list (options)
 * ionoscloud\_password
 
 ```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
     limit: --limit LIMIT, -l LIMIT
         the maximum number of requests to look into.
 
@@ -32,9 +35,12 @@ knife ionoscloud request list (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 
 ```text
-knife ionoscloud request list --limit LIMIT --offset OFFSET --status STATUS --method METHOD --username USERNAME --password PASSWORD
+knife ionoscloud request list --extra-config EXTRA_CONFIG_FILE_PATH --limit LIMIT --offset OFFSET --status STATUS --method METHOD --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/{request_status.md → compute-engine/request_status.md}

@@ -15,6 +15,9 @@ knife ionoscloud request status (options)
 * ionoscloud\_password
 
 ```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
     request_id: --request-id REQUEST_ID, -R REQUEST_ID
         the ID of the Request. (required)
 
@@ -24,9 +27,12 @@ knife ionoscloud request status (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 
 ```text
-knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD
+knife ionoscloud request status --extra-config EXTRA_CONFIG_FILE_PATH --request-id REQUEST_ID --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/{request_wait.md → compute-engine/request_wait.md}

@@ -15,6 +15,9 @@ knife ionoscloud request wait (options)
 * ionoscloud\_password
 
 ```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
     request_id: --request-id REQUEST_ID, -R REQUEST_ID
         the ID of the Backup unit. (required)
 
@@ -24,9 +27,12 @@ knife ionoscloud request wait (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 
 ```text
-knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD
+knife ionoscloud request wait --extra-config EXTRA_CONFIG_FILE_PATH --request-id REQUEST_ID --username USERNAME --password PASSWORD --url URL
 ```

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

@@ -0,0 +1,42 @@
+# ServerConsole
+
+Returns the link with the jwToken to access the server remote console.
+
+```text
+knife ionoscloud server console (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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 Datacenter. (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the Server. (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 server console --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/{server_create.md → compute-engine/server_create.md}

@@ -19,6 +19,9 @@ knife ionoscloud server create (options)
 * 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 virtual datacenter (required)
 
@@ -49,9 +52,12 @@ knife ionoscloud server create (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 
 ```text
-knife ionoscloud server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD
+knife ionoscloud server create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/{server_delete.md → compute-engine/server_delete.md}

@@ -17,6 +17,9 @@ knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
 * 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)
 
@@ -26,6 +29,9 @@ knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 

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

@@ -0,0 +1,42 @@
+# ServerGet
+
+Retrieves the attributes of a given Server.
+
+```text
+knife ionoscloud server get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (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 server get --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/{server_list.md → compute-engine/server_list.md}

@@ -15,18 +15,27 @@ knife ionoscloud server list (options)
 * 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 datacenter containing the server (required)
 
+    upgrade_needed: --upgrade-needed, -u
+        it can be used to filter which servers can be upgraded
+
     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 server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
+knife ionoscloud server list --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --upgrade-needed --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/{server_reboot.md → compute-engine/server_reboot.md}

@@ -15,6 +15,9 @@ knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
 * 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)
 
@@ -24,6 +27,9 @@ knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 

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

@@ -0,0 +1,38 @@
+# ServerResume
+
+This will resume a suspended server. The operation can only be applied to suspended Cube servers. No billing event will be generated.
+
+```text
+knife ionoscloud server resume SERVER_ID [SERVER_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
+        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 server resume SERVER_ID 
+```

data/docs/subcommands/{server_start.md → compute-engine/server_start.md}

@@ -15,6 +15,9 @@ knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
 * 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)
 
@@ -24,6 +27,9 @@ knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 

data/docs/subcommands/{server_stop.md → compute-engine/server_stop.md}

@@ -15,6 +15,9 @@ knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
 * 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)
 
@@ -24,6 +27,9 @@ knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 

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

@@ -0,0 +1,38 @@
+# ServerSuspend
+
+This will suspend a server. The operation can only be applied to Cube servers. Note: The virtual machine will not be deleted, and the consumed resources will continue to be billed.
+
+```text
+knife ionoscloud server suspend SERVER_ID [SERVER_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
+        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 server suspend SERVER_ID 
+```

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

@@ -0,0 +1,42 @@
+# ServerToken
+
+Returns the server json web token to be used for login operations (ex: accessing the server console).
+
+```text
+knife ionoscloud server token (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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 Datacenter. (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the Server. (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 server token --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
+```

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

@@ -0,0 +1,63 @@
+# ServerUpdate
+
+Updates information about a Ionoscloud Server.
+
+```text
+knife ionoscloud server update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the server to which the NIC is assigned (required)
+
+    name: --name NAME, -n NAME
+        name of the server
+
+    cores: --cores CORES, -C CORES
+        the number of processor cores
+
+    cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
+        the family of the CPU (INTEL_XEON or AMD_OPTERON)
+
+    ram: --ram RAM, -r RAM
+        the amount of RAM in MB
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
+        the availability zone of the server
+
+    boot_volume: --boot-volume VOLUME_ID
+        reference to a volume used for booting
+
+    boot_cdrom: --boot-cdrom CDROM_ID
+        reference to a CD-ROM used for booting
+
+    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 server update --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD --url URL
+```

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

@@ -0,0 +1,42 @@
+# ServerUpgrade
+
+This will upgrade the version of the server, if needed. To verify if there is an upgrade available for a server, call '/datacenters/{datacenterId}/servers?upgradeNeeded=true'.
+
+```text
+knife ionoscloud server upgrade (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* server\_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 Datacenter. (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        the ID of the Server. (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 server upgrade --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --url URL
+```

data/docs/subcommands/{snapshot_create.md → compute-engine/snapshot_create.md}

@@ -16,6 +16,9 @@ knife ionoscloud snapshot create (options)
 * 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 DATACENTER_ID, -D DATACENTER_ID
         iD of the Datacenter (required)
 
@@ -40,9 +43,12 @@ knife ionoscloud snapshot create (options)
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
 ```
 ## Example
 
 ```text
-knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --name SNAPSHOT_NAME --description SNAPSHOT_DESCRIPTION --sec-auth --licence LICENCE_TYPE --username USERNAME --password PASSWORD
+knife ionoscloud snapshot create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter DATACENTER_ID --volume VOLUME_ID --name SNAPSHOT_NAME --description SNAPSHOT_DESCRIPTION --sec-auth --licence LICENCE_TYPE --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/{snapshot_delete.md → compute-engine/snapshot_delete.md}

@@ -14,15 +14,21 @@ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]
 * ionoscloud\_password
 
 ```text
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
     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 snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD
+knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--extra-config EXTRA_CONFIG_FILE_PATH --username USERNAME --password PASSWORD --url URL
 ```