knife-ionoscloud 5.1.2 → 6.0.0.alpha.1

data/docs/subcommands/nic_update.md

@@ -1,58 +0,0 @@
-# NicUpdate
-
-Updates information about a Ionoscloud NIC.
-
-```text
-knife ionoscloud nic update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* 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)
-
-    server_id: --server-id SERVER_ID, -S SERVER_ID
-        the ID of the server to which the NIC is assigned (required)
-
-    nic_id: --nic-id NIC_ID, -N NIC_ID
-        iD of the load balancer (required)
-
-    name: --name NAME, -n NAME
-        name of the NIC
-
-    ips: --ips IP[,IP,...], -i IP[,IP,...]
-        iPs assigned to the NIC
-
-    dhcp: --dhcp DHCP
-        set to false if you wish to disable DHCP
-
-    lan: --lan ID, -l ID
-        the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created
-
-    nat: --nat NAT
-        set to enable NAT on 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 nic update --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --ips IP[,IP,...] --dhcp DHCP --lan ID --nat NAT --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/node_get.md

@@ -1,43 +0,0 @@
-# NodeGet
-
-Retrieves the attributes of a given K8S Node.
-
-```text
-knife ionoscloud node get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* cluster\_id
-* nodepool\_id
-* node\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
-        the ID of the K8s Cluster (required)
-
-    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
-        the ID of the K8s Nodepool (required)
-
-    node_id: --node-id NODE_ID, -N NODE_ID
-        iD of the load balancer (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 node get --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --node-id NODE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/nodepool_get.md

@@ -1,39 +0,0 @@
-# NodepoolGet
-
-Retrieves the attributes of a given K8S Nodepool.
-
-```text
-knife ionoscloud nodepool get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* cluster\_id
-* nodepool\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
-        the ID of the K8s Cluster (required)
-
-    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
-        the ID of the K8s Nodepool (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 nodepool get --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/nodepool_update.md

@@ -1,69 +0,0 @@
-# NodepoolUpdate
-
-Updates information about a Ionoscloud K8s Nodepool.
-
-```text
-knife ionoscloud nodepool update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* cluster\_id
-* nodepool\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
-        iD of the Kubernetes cluster (required)
-
-    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
-        iD of the Kubernetes nodepool (required)
-
-    k8s_version: --version VERSION, -v VERSION
-        the version for the Kubernetes cluster.
-
-    maintenance_day: --maintenance-day MAINTENANCE_DAY
-        day Of the week when to perform the maintenance.
-
-    maintenance_time: --maintenance-time MAINTENANCE_TIME, -t MAINTENANCE_TIME
-        time Of the day when to perform the maintenance.
-
-    node_count: --node-count NODE_COUNT, -c NODE_COUNT
-        the number of worker nodes that the node pool should contain. Min 2, Max: Determined by the resource availability.
-
-    min_node_count: --min-node-count MIN_NODE_COUNT
-        the minimum number of worker nodes that the managed node group can scale in
-
-    max_node_count: --max-node-count MAX_NODE_COUNT
-        the maximum number of worker nodes that the managed node pool can scale-out.
-
-    lans: --lans LAN_ID [LAN_ID]
-        an array of additional private LANs attached to worker nodes
-
-    public_ips: --ips PUBLIC_IP [PUBLIC_IP]
-        optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.
-
-    labels: --labels LABEL [LABEL]
-        map of labels attached to node pool
-
-    annotations: --annotations ANNOTATION [ANNOTATION]
-        map of annotations attached to node pool
-
-    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 nodepool update --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --ips PUBLIC_IP [PUBLIC_IP] --labels LABEL [LABEL] --annotations ANNOTATION [ANNOTATION] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/pcc_get.md

@@ -1,35 +0,0 @@
-# PccGet
-
-Retrieves information about a Ionoscloud Private Cross Connect.
-
-```text
-knife ionoscloud pcc get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* pcc\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
-        iD of the Private Cross Connect (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 pcc get --pcc-id PRIVATE_CROSS_CONNECT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/pcc_update.md

@@ -1,41 +0,0 @@
-# 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
-    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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud pcc update --pcc-id PRIVATE_CROSS_CONNECT_ID --name NAME --description DESCRIPTION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/request_get.md

@@ -1,35 +0,0 @@
-# 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
-    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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud request get --request-id REQUEST_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/s3key_get.md

@@ -1,39 +0,0 @@
-# S3keyGet
-
-Retrieves the properties of an S3 Key.
-
-```text
-knife ionoscloud s3key get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* user\_id
-* s3\_key\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    user_id: --user USER_ID, -u USER_ID
-        the ID of the user (required)
-
-    s3_key_id: --s3-key S3KEY_ID, -S S3KEY_ID
-        the ID of the S3 Key. (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 s3key get --user USER_ID --s3-key S3KEY_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/server_get.md

@@ -1,39 +0,0 @@
-# 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
-    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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud server get --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/server_update.md

@@ -1,60 +0,0 @@
-# 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
-    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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud server update --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 --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/share_get.md

@@ -1,39 +0,0 @@
-# ShareGet
-
-Retrieves the attributes of a given Group Share.
-
-```text
-knife ionoscloud share get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* group\_id
-* resource\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    group_id: --group-id GROUP_ID, -G GROUP_ID
-        iD of the group. (required)
-
-    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
-        the ID of the resource. (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 share get --group-id GROUP_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/share_update.md

@@ -1,45 +0,0 @@
-# ShareUpdate
-
-Updates information about a Ionoscloud Group Share.
-
-```text
-knife ionoscloud share update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* group\_id
-* resource\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    group_id: --group-id GROUP_ID, -G GROUP_ID
-        iD of the group. (required)
-
-    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
-        the ID of the resource. (required)
-
-    edit_privilege: --edit EDIT_PRIVILEGE
-        the group has permission to edit privileges on this resource.
-
-    share_privilege: --share SHARE_PRIVILEGE, -s SHARE_PRIVILEGE
-        the group has permission to share this resource.
-
-    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 share update --group-id GROUP_ID --resource-id RESOURCE_ID --edit EDIT_PRIVILEGE --share SHARE_PRIVILEGE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/snapshot_get.md

@@ -1,35 +0,0 @@
-# SnapshotGet
-
-Retrieves the attributes of a given Snapshot.
-
-```text
-knife ionoscloud snapshot get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* snapshot\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud snapshot get --snapshot-id SNAPSHOT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/snapshot_update.md

@@ -1,77 +0,0 @@
-# SnapshotUpdate
-
-Updates information about a Ionoscloud Snapshot.
-
-```text
-knife ionoscloud snapshot update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* snapshot\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    snapshot_id: --snapshot-id SNAPSHOT_ID, -S SNAPSHOT_ID
-        iD of the Snapshot. (required)
-
-    name: --name NAME, -n NAME
-        name of the server
-
-    description: --description DESCRIPTION
-        the number of processor cores
-
-    sec_auth_protection: --sec-auth-protection SEC_AUTH_PROTECTION
-        boolean value representing if the snapshot requires extra protection e.g. two factor protection
-
-    licence_type: --licence-type LICENCE, -l LICENCE
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    cpu_hot_plug: --cpu-hot-plug CPU_HOT_PLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    cpu_hot_unplug: --cpu-hot-unplug CPU_HOT_UNPLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    ram_hot_plug: --ram-hot-plug RAM_HOT_PLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    ram_hot_unplug: --ram-hot-unplug RAM_HOT_UNPLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    nic_hot_plug: --nic-hot-plug NIC_HOT_PLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    nic_hot_unplug: --nic-hot-unplug NIC_HOT_UNPLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    disc_virtio_hot_plug: --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    disc_virtio_hot_unplug: --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    disc_scsi_hot_plug: --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    disc_scsi_hot_unplug: --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG
-        the licence type of the snapshot (LINUX, WINDOWS, UNKNOWN, OTHER)
-
-    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 snapshot update --snapshot-id SNAPSHOT_ID --name NAME --description DESCRIPTION --sec-auth-protection SEC_AUTH_PROTECTION --licence-type LICENCE --cpu-hot-plug CPU_HOT_PLUG --cpu-hot-unplug CPU_HOT_UNPLUG --ram-hot-plug RAM_HOT_PLUG --ram-hot-unplug RAM_HOT_UNPLUG --nic-hot-plug NIC_HOT_PLUG --nic-hot-unplug NIC_HOT_UNPLUG --disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG --disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG --disc-scsi-hot-plug DISC_SCSI_HOT_PLUG --disc-scsi-hot-unplug DISC_SCSI_HOT_UNPLUG --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```