knife-ionoscloud 5.0.0.beta.1

data/docs/subcommands/datacenter_delete.md

@@ -0,0 +1,26 @@
+# DatacenterDelete
+
+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]
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/datacenter_list.md

@@ -0,0 +1,26 @@
+# DatacenterList
+
+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
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud datacenter list--username USERNAME --password PASSWORD

data/docs/subcommands/firewall_create.md

@@ -0,0 +1,65 @@
+# FirewallCreate
+
+Creates a new firewall rule on an existing NIC.
+
+    knife ionoscloud firewall create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* server_id
+* nic_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    server_id: --server-id SERVER_ID, -S SERVER_ID
+        iD of the server (required)
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC (required)
+
+    name: --name NAME, -n NAME
+        name of the NIC
+
+    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)
+
+```
+
+## 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

data/docs/subcommands/firewall_delete.md

@@ -0,0 +1,38 @@
+# FirewallDelete
+
+Deletes a firewall rule from an existing NIC.
+
+    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: --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)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud firewall delete FIREWALL_ID 

data/docs/subcommands/firewall_list.md

@@ -0,0 +1,38 @@
+# FirewallList
+
+Lists all available firewall rules assigned to a NIC.
+
+    knife ionoscloud firewall list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* server_id
+* nic_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    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 (required)
+
+    nic_id: --nic-id NIC_ID, -N NIC_ID
+        iD of the NIC (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD

data/docs/subcommands/group_create.md

@@ -0,0 +1,48 @@
+# GroupCreate
+
+Use this operation to create a new group and set group privileges.
+
+    knife ionoscloud group create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* name
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    name: --name NAME, -N NAME
+        mame of the group. (required)
+
+    create_data_center: --create-datacenter, -D
+        the group will be allowed to create virtual data centers.
+
+    create_snapshot: --create-snapshot, -s
+        the group will be allowed to create snapshots.
+
+    reserve_ip: --reserve-ip, -i
+        the group will be allowed to reserve IP addresses.
+
+    access_activity_log: --access-log, -a
+        the group will be allowed to access the activity log.
+
+    s3_privilege: --s3
+        the group will be allowed to manage S3
+
+    create_backup_unit: --create-backupunit, -b
+        the group will be able to manage backup units.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --username USERNAME --password PASSWORD

data/docs/subcommands/group_delete.md

@@ -0,0 +1,26 @@
+# GroupDelete
+
+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]
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/group_get.md

@@ -0,0 +1,30 @@
+# GroupGet
+
+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)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -G GROUP_ID
+        iD of the group. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group get --group-id GROUP_ID --username USERNAME --password PASSWORD

data/docs/subcommands/group_list.md

@@ -0,0 +1,29 @@
+# GroupList
+
+This retrieves a full list of all groups.
+
+    knife ionoscloud group list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    user_id: --user-id USER_ID, -u USER_ID
+        iD of the user.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group list --user-id USER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/group_user_add.md

@@ -0,0 +1,30 @@
+# GroupUserAdd
+
+Use this operation to add an existing user to a group.
+
+    knife ionoscloud group user add USER_ID [USER_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -G GROUP_ID
+        iD of the group. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group user add USER_ID 

data/docs/subcommands/group_user_remove.md

@@ -0,0 +1,30 @@
+# GroupUserRemove
+
+Use this operation to remove a user from a group.
+
+    knife ionoscloud group user remove USER_ID [USER_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* group_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    group_id: --group-id GROUP_ID, -G GROUP_ID
+        iD of the group. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud group user remove USER_ID 

data/docs/subcommands/image_list.md

@@ -0,0 +1,26 @@
+# ImageList
+
+A list of disk and ISO images are available from Ionoscloud for immediate use. Make sure the image you use is in the same location as the virtual data center.
+
+    knife ionoscloud image list
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud image list--username USERNAME --password PASSWORD

data/docs/subcommands/ipblock_create.md

@@ -0,0 +1,37 @@
+# IpblockCreate
+
+Reserves an IP block at a specified location that can be used by resources within any VDCs provisioned in that same location. An IP block consists of one or more static IP addresses. The IP block size (number of IP addresses) and location are required to reserve an IP block.
+
+    knife ionoscloud ipblock create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* size
+* location
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    location: --location LOCATION, -l LOCATION
+        location of the IP block (us/las, us/ewr, de/fra, de/fkb) (required)
+
+    size: --size INT, -S INT
+        the number of IP addresses to reserve (required)
+
+    name: --name NAME, -n NAME
+        name of the IP block
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud ipblock create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD