knife-ionoscloud 5.1.2 → 6.0.0.alpha.1

data/docs/subcommands/backupunit_update.md

@@ -1,41 +0,0 @@
-# BackupunitUpdate
-
-Retrieves information about a backup unit.
-
-```text
-knife ionoscloud backupunit update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* backupunit\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
-        the ID of the Backup unit. (required)
-
-    password: --password PASSWORD, -p PASSWORD
-        alphanumeric password you want assigned to the backup unit
-
-    email: --email EMAIL
-        the e-mail address you want assigned to the backup unit.
-
-    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 backupunit update --backupunit-id BACKUPUNIT_ID --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/datacenter_get.md

@@ -1,35 +0,0 @@
-# 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_update.md

@@ -1,44 +0,0 @@
-# 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_get.md

@@ -1,47 +0,0 @@
-# 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_update.md

@@ -1,71 +0,0 @@
-# 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_update.md

@@ -1,65 +0,0 @@
-# GroupUpdate
-
-Updates information about a Ionoscloud Group.
-
-```text
-knife ionoscloud group update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* group\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    group_id: --group-id GROUP_ID, -G GROUP_ID
-        iD of the group. (required)
-
-    name: --name NAME, -N NAME
-        mame of the group.
-
-    create_data_center: --create-datacenter CREATE_DATACENTER, -D CREATE_DATACENTER
-        the group will be allowed to create virtual data centers.
-
-    create_snapshot: --create-snapshot CREATE_SNAPSHOT, -s CREATE_SNAPSHOT
-        the group will be allowed to create snapshots.
-
-    reserve_ip: --reserve-ip RESERVE_IP, -i RESERVE_IP
-        the group will be allowed to reserve IP addresses.
-
-    access_activity_log: --access-log ACCESS_ACTIVITY_LOG, -a ACCESS_ACTIVITY_LOG
-        the group will be allowed to access the activity log.
-
-    s3_privilege: --s3 S3_PRIVILEGE
-        the group will be allowed to manage S3
-
-    create_backup_unit: --create-backupunit CREATE_BACKUPUNIT, -b CREATE_BACKUPUNIT
-        the group will be able to manage backup units.
-
-    create_k8s_cluster: --create-k8s-cluster CREATE_K8S_CLUSTER
-        the group will be able to create kubernetes clusters.
-
-    create_pcc: --create-pcc CREATE_PCC
-        the group will be able to manage pccs.
-
-    create_internet_access: --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
-
-```text
-knife ionoscloud group update --group-id GROUP_ID --name NAME --create-datacenter CREATE_DATACENTER --create-snapshot CREATE_SNAPSHOT --reserve-ip RESERVE_IP --access-log ACCESS_ACTIVITY_LOG --s3 S3_PRIVILEGE --create-backupunit CREATE_BACKUPUNIT --create-k8s-cluster CREATE_K8S_CLUSTER --create-pcc CREATE_PCC --create-internet-access CREATE_INTERNET_ACCESS --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/ipblock_get.md

@@ -1,35 +0,0 @@
-# IpblockGet
-
-Retrieves information about an IP Block.
-
-```text
-knife ionoscloud ipblock get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* ipblock\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    ipblock_id: --ipblock-id IPBLOCK_ID, -I IPBLOCK_ID
-        iD of the IPBlock. (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 ipblock get --ipblock-id IPBLOCK_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/ipblock_update.md

@@ -1,38 +0,0 @@
-# IpblockUpdate
-
-Updates information about an IP Block.
-
-```text
-knife ionoscloud ipblock update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* ipblock\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    ipblock_id: --ipblock-id IPBLOCK_ID, -I IPBLOCK_ID
-        iD of the IPBlock. (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)
-
-    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
-        path to the additional config file
-
-```
-## Example
-
-```text
-knife ionoscloud ipblock update --ipblock-id IPBLOCK_ID --name NAME --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/k8s_get.md

@@ -1,35 +0,0 @@
-# K8sGet
-
-Retrieves information about a K8s Cluster.
-
-```text
-knife ionoscloud k8s get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* cluster\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
-        iD of the Kubernetes cluster (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 k8s get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/k8s_update.md

@@ -1,53 +0,0 @@
-# K8sUpdate
-
-Updates information about a Ionoscloud K8s Cluster.
-
-```text
-knife ionoscloud k8s update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* cluster\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
-        iD of the Kubernetes cluster (required)
-
-    name: --name NAME, -n NAME
-        name of the server
-
-    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.
-
-    api_subnet_allow_list: --subnets SUBNET[,SUBNET,...]
-        access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.
-
-    s3_buckets: --s3-buckets BUCKET[,BUCKET,...]
-        list of S3 bucket configured for K8s usage. For now it contains only one S3 bucket used to store K8s API audit logs.
-
-    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 k8s update --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --subnets SUBNET[,SUBNET,...] --s3-buckets BUCKET[,BUCKET,...] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/lan_get.md

@@ -1,39 +0,0 @@
-# LanGet
-
-Retrieves information about a Ionoscloud LAN.
-
-```text
-knife ionoscloud lan get (options)
-```
-
-## Available options:
-
-### Required options:
-
-* datacenter\_id
-* lan\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
-        iD of the data center (required)
-
-    lan_id: --lan-id LAN_ID, -L LAN_ID
-        iD of the LAN (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 lan get --datacenter-id DATACENTER_ID --lan-id LAN_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/lan_update.md

@@ -1,51 +0,0 @@
-# LanUpdate
-
-Updates information about a Ionoscloud LAN.
-
-```text
-knife ionoscloud lan update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* datacenter\_id
-* lan\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
-        iD of the data center (required)
-
-    lan_id: --lan-id LAN_ID, -L LAN_ID
-        iD of the LAN (required)
-
-    name: --name NAME, -n NAME
-        name of the server
-
-    public: --public PUBLIC, -p PUBLIC
-        boolean indicating if the LAN faces the public Internet or not; defaults to false
-
-    pcc: --pcc PCC_ID
-        iD of the PCC to connect the LAN to
-
-    ip_failover: --ip-failover IPFAILOVER [IPFAILOVER]
-        iP failover configurations for lan
-
-    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 lan update --datacenter-id DATACENTER_ID --lan-id LAN_ID --name NAME --public PUBLIC --pcc PCC_ID --ip-failover IPFAILOVER [IPFAILOVER] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/loadbalancer_update.md

@@ -1,48 +0,0 @@
-# LoadbalancerUpdate
-
-Updates information about a Ionoscloud Load Balancer.
-
-```text
-knife ionoscloud loadbalancer update (options)
-```
-
-## Available options:
-
-### Required options:
-
-* datacenter\_id
-* loadbalancer\_id
-* ionoscloud\_username
-* ionoscloud\_password
-
-```text
-    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
-        iD of the data center (required)
-
-    loadbalancer_id: --loadbalancer-id LOADBALANCER_ID, -L LOADBALANCER_ID
-        iD of the load balancer (required)
-
-    name: --name NAME, -n NAME
-        name of the load balancer
-
-    ip: --ip IP
-        iPv4 address of the load balancer. All attached NICs will inherit this IP.
-
-    dhcp: --dhcp DHCP
-        indicates if the load balancer will reserve an IP using DHCP.
-
-    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 loadbalancer update --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --name NAME --ip IP --dhcp DHCP --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```

data/docs/subcommands/nic_get.md

@@ -1,43 +0,0 @@
-# NicGet
-
-Retrieves the attributes of a given NIC.
-
-```text
-knife ionoscloud nic get (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)
-
-    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 get --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
-```