knife-ionoscloud 6.1.2 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4dfebeb89ee86a0abd221492442b0d76fbcf0acd5f8e3fa14a8136a8742a6c
-  data.tar.gz: 0e68b7d6f007055b3ab0384d0f76c6f4a9e0ef7c85eb2e02c938a9dceaa5165e
+  metadata.gz: 71feff7578cd72f6d66fe20aa5b0ddf73d655075ea5d4023fbe505aa961f74c1
+  data.tar.gz: 973e78b70f6d7982c829e754c120474ddbb2de4fd8f7f963d88bd8d9f2c7c61c
 SHA512:
-  metadata.gz: 17363710498faa62b78ee1791a942adcfc145b195b2f267a89291479ab0b8619db1cf2c002d885d40927556af48dc4ada4844d0119c4af5618291e9253cc435b
-  data.tar.gz: ededda9b79d47881a1ac890ff09dc23ad40f0a64e4111dd566050a70afcb0162e3f194b8ad1d5f4cc36bd7c9370b77cb0ddfc8a0eeef755e247f1d5ecf365b76
+  metadata.gz: a4f1412269e2b2f5b554712a5921aecb73918b1f90718d34b1c0aeefe9dd5b6b829bd3e3594a0029cdbebf2b930d1dfaa94fcc1845db83d0238287d2660d8dc4
+  data.tar.gz: 5532f4c4f7c9b3011044871fbafbff63284e288715d82346743b90d15877f852d7bdd6d80090ad1f20c7e1cb3f71ab5fbc6b9dfb70b45c4e86f19331bd2e4ab2

data/docs/changelog.md

@@ -19,3 +19,11 @@
 * added direction, since and until arguments to logs get command
 * added private argument to k8s cluster create
 * added gateway_ip argument to nodepool create
+
+## 6.1.2
+
+### Enhancements:
+
+* added token authentication
+* removed private argument from k8s create
+* removed gateway_ip argument from nodepool create

data/docs/docs_generator.rb

@@ -15,6 +15,7 @@ FOLDER_TO_NAME_MAP = {
   'compute-engine' => 'Compute Engine',
   'kubernetes' => 'Managed Kubernetes',
   'dbaas-postgres' => 'DBaaS Postgres',
+  'application-loadbalancer' => 'Application Load Balancer',
 }.freeze
 
 def underscore_string(s)
@@ -135,5 +136,5 @@ final_categories = []
 categories.map { |key, value| final_categories << { category: key, subcommands: value.sort_by { |a| a[:title] } } }
 
 File.open('summary.md', 'w') do |f|
-  f.write(Summary.new(final_categories).render)
+  f.write(Summary.new(final_categories.sort_by { |a| a[:category].to_s }).render)
 end

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_create.md

@@ -0,0 +1,60 @@
+# ApplicationloadbalancerCreate
+
+Creates an Application Load Balancer within the datacenter.
+
+```text
+knife ionoscloud applicationloadbalancer create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* name
+* listener\_lan
+* target\_lan
+* ips
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    name: --name NAME, -n NAME
+        name of the Application Load Balancer (required)
+
+    listener_lan: --listener-lan LISTENER_LAN_ID, -l LISTENER_LAN_ID
+        id of the listening LAN. (inbound) (required)
+
+    target_lan: --target-lan TARGET_LAN_ID, -t TARGET_LAN_ID
+        id of the balanced private target LAN. (outbound) (required)
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of IP addresses of the Application Load Balancer. (inbound and outbound) IP of the listenerLan must be a customer reserved IP for the public load balancer and private IP for the private load balancer. (required)
+
+    lb_private_ips: --private-ips IP[,IP,...]
+        collection of private IP addresses with subnet mask of the Application Load Balancer. IPs must contain valid subnet mask. If user will not provide any IP then the system will generate one IP with /24 subnet.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer create --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --listener-lan LISTENER_LAN_ID --target-lan TARGET_LAN_ID --ips IP[,IP,...] --private-ips IP[,IP,...] --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_delete.md

@@ -0,0 +1,41 @@
+# ApplicationloadbalancerDelete
+
+Removes the specified Application Load Balancer.
+
+```text
+knife ionoscloud applicationloadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer delete LOAD_BALANCER_ID 
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_get.md

@@ -0,0 +1,45 @@
+# ApplicationloadbalancerGet
+
+Retrieves the attributes of a given Application Load Balancer.
+
+```text
+knife ionoscloud applicationloadbalancer get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer get --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer NETWORK_LOADBALANCER_ID --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_list.md

@@ -0,0 +1,41 @@
+# ApplicationloadbalancerList
+
+Retrieve a list of Application Load Balancers within the datacenter.
+
+```text
+knife ionoscloud applicationloadbalancer list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer list --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_add.md

@@ -0,0 +1,69 @@
+# ApplicationloadbalancerRuleAdd
+
+Adds a Forwarding Rule to a Application Load Balancer under a data center.
+
+```text
+knife ionoscloud applicationloadbalancer rule add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* name
+* listener\_ip
+* listener\_port
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    name: --name NAME, -n NAME
+        a name of that Application Load Balancer forwarding rule (required)
+
+    protocol: --protocol PROTOCOL
+        protocol of the balancing
+
+    listener_ip: --ip LISTENER_IP, -i LISTENER_IP
+        listening IP. (inbound) (required)
+
+    listener_port: --port LISTENER_PORT, -p LISTENER_PORT
+        listening port number. (inbound) (range: 1 to 65535) (required)
+
+    client_timeout: --client-timeout CLIENT_TIMEOUT
+        clientTimeout is expressed in milliseconds. This inactivity timeout applies when the client is expected to acknowledge or send data. If unset the default of 50 seconds will be used.
+
+    server_certificates: --certificates SERVER_CERTIFICATES
+        array of server certificates
+
+    http_rules: --http-rules HTTP_RULES
+        array of HTTP Rules
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule add --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer APPLICATION_LOADBALANCER_ID --name NAME --protocol PROTOCOL --ip LISTENER_IP --port LISTENER_PORT --client-timeout CLIENT_TIMEOUT --certificates SERVER_CERTIFICATES --http-rules HTTP_RULES --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_httprule_add.md

@@ -0,0 +1,78 @@
+# ApplicationloadbalancerRuleHttpruleAdd
+
+Adds a Http Rule to a Application Load Balancer Forwarding Rule under a data center or updates it if one already exists.
+
+```text
+knife ionoscloud applicationloadbalancer rule httprule add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* forwarding\_rule\_id
+* name
+* type
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Application Loadbalancer Forwarding Rule (required)
+
+    name: --name NAME, -n NAME
+        the name of a Application Load Balancer http rule; unique per forwarding rule (required)
+
+    type: --type TYPE, -t TYPE
+        type of the Http Rule. (required)
+
+    target_group: --target-group TARGET_GROUP_ID
+        the UUID of the target group; mandatory and only valid for FORWARD action.
+
+    drop_query: --query QUERY, -q QUERY
+        default is false; valid only for REDIRECT action.
+
+    location: --location LOCATION, -l LOCATION
+        the location for redirecting; mandatory and valid only for REDIRECT action.
+
+    status_code: --code STATUS_CODE
+        valid only for action REDIRECT and STATIC; on REDIRECT action default is 301 and it can take the values 301, 302, 303, 307, 308; on STATIC action default is 503 and it can take a value between 200 and 599
+
+    response_message: --message MESSAGE, -m MESSAGE
+        the response message of the request; mandatory for STATIC action
+
+    content_type: --content-type CONTENT_TYPE
+        valid only for action STATIC
+
+    conditions: --conditions CONDITIONS
+        array of conditions for the HTTP Rule
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule httprule add --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer APPLICATION_LOADBALANCER_ID --forwarding-rule FORWARDING_RULE_ID --name NAME --type TYPE --target-group TARGET_GROUP_ID --query QUERY --location LOCATION --code STATUS_CODE --message MESSAGE --content-type CONTENT_TYPE --conditions CONDITIONS --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_httprule_remove.md

@@ -0,0 +1,49 @@
+# ApplicationloadbalancerRuleHttpruleRemove
+
+Removes a Http Rule from a Application Load Balancer Forwarding Rule.
+
+```text
+knife ionoscloud applicationloadbalancer rule httprule remove HTTP_RULE_NAME [HTTP_RULE_NAME] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* forwarding\_rule\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Application Loadbalancer Forwarding Rule (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule httprule remove HTTP_RULE_NAME 
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_remove.md

@@ -0,0 +1,45 @@
+# ApplicationloadbalancerRuleRemove
+
+Removes the specified rules from a Application Loadbalancer under a data center.
+
+```text
+knife ionoscloud applicationloadbalancer rule remove RULE_ID [RULE_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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 data center (required)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule remove RULE_ID 
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_update.md

@@ -0,0 +1,70 @@
+# ApplicationloadbalancerRuleUpdate
+
+Updates information about a Ionoscloud Application LoadBalancer Forwarding Rule.
+
+```text
+knife ionoscloud applicationloadbalancer rule update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* forwarding\_rule\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    forwarding_rule_id: --forwarding-rule FORWARDING_RULE_ID, -R FORWARDING_RULE_ID
+        iD of the Application Loadbalancer Forwarding Rule (required)
+
+    name: --name NAME, -n NAME
+        a name of that Application Load Balancer forwarding rule
+
+    protocol: --protocol PROTOCOL
+        protocol of the balancing
+
+    listener_ip: --ip LISTENER_IP, -i LISTENER_IP
+        listening IP. (inbound)
+
+    listener_port: --port LISTENER_PORT, -p LISTENER_PORT
+        listening port number. (inbound) (range: 1 to 65535)
+
+    client_timeout: --client-timeout CLIENT_TIMEOUT
+        clientTimeout is expressed in milliseconds. This inactivity timeout applies when the client is expected to acknowledge or send data. If unset the default of 50 seconds will be used.
+
+    server_certificates: --certificates SERVER_CERTIFICATES
+        array of server certificates
+
+    http_rules: --http-rules HTTP_RULES
+        array of HTTP Rules
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule update --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer APPLICATION_LOADBALANCER_ID --forwarding-rule FORWARDING_RULE_ID --name NAME --protocol PROTOCOL --ip LISTENER_IP --port LISTENER_PORT --client-timeout CLIENT_TIMEOUT --certificates SERVER_CERTIFICATES --http-rules HTTP_RULES --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_update.md

@@ -0,0 +1,60 @@
+# ApplicationloadbalancerUpdate
+
+Updates information about a Ionoscloud Application LoadBalancer.
+
+```text
+knife ionoscloud applicationloadbalancer update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    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)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    name: --name NAME, -n NAME
+        name of the Application Load Balancer
+
+    listener_lan: --listener-lan LISTENER_LAN_ID, -l LISTENER_LAN_ID
+        id of the listening LAN. (inbound)
+
+    target_lan: --target-lan TARGET_LAN_ID, -t TARGET_LAN_ID
+        id of the balanced private target LAN. (outbound)
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of IP addresses of the Application Load Balancer. (inbound and outbound) IP of the listenerLan must be a customer reserved IP for the public load balancer and private IP for the private load balancer.
+
+    lb_private_ips: --private-ips IP[,IP,...]
+        collection of private IP addresses with subnet mask of the Application Load Balancer. IPs must contain valid subnet mask. If user will not provide any IP then the system will generate one IP with /24 subnet.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer update --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer APPLICATION_LOADBALANCER_ID --name NAME --listener-lan LISTENER_LAN_ID --target-lan TARGET_LAN_ID --ips IP[,IP,...] --private-ips IP[,IP,...] --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/targetgroup_create.md

@@ -0,0 +1,79 @@
+# TargetgroupCreate
+
+Creates a new Target Group.
+
+```text
+knife ionoscloud targetgroup create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* name
+* algorithm
+* protocol
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    name: --name NAME, -n NAME
+        name of the server (required)
+
+    algorithm: --algorithm ALGORITHM, -a ALGORITHM
+        algorithm for the balancing. One of ["ROUND_ROBIN", "LEAST_CONNECTION", "RANDOM", "SOURCE_IP"] (required)
+
+    protocol: --protocol PROTOCOL, -p PROTOCOL
+        protocol of the balancing. One of ["HTTP"] (required)
+
+    check_timeout: --check-timeout CHECK_TIMEOUT
+        it specifies the time (in milliseconds) for a target VM in this pool to answer the check. If a target VM has CheckInterval set and CheckTimeout is set too, then the smaller value of the two is used after the TCP connection is established.
+
+    check_interval: --check-interval check_interval
+        it specifies the maximum time (in milliseconds) to wait for a connection attempt to a target VM to succeed. If unset, the default of 5 seconds will be used.
+
+    retries: --retries RETRIES, -r RETRIES
+        retries specifies the number of retries to perform on a target VM after a connection failure. If unset, the default value of 3 will be used. (valid range: [0, 65535])
+
+    path: --path PATH
+        the path for the HTTP health check; default: /.
+
+    method: --method METHOD, -m METHOD
+        the method for the HTTP health check.
+
+    match_type: --match-type MATCH_TYPE
+        the method for the HTTP health check. One of ["STATUS_CODE", "RESPONSE_BODY"].
+
+    response: --response RESPONSE
+        the response returned by the request.
+
+    regex: --regex REGEX
+        the regex used.
+
+    negate: --negate
+        whether to negate or not.
+
+    targets: --targets
+        array of TargetGroup targets.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud targetgroup create --url URL --extra-config EXTRA_CONFIG_FILE_PATH --name NAME --algorithm ALGORITHM --protocol PROTOCOL --check-timeout CHECK_TIMEOUT --check-interval check_interval --retries RETRIES --path PATH --method METHOD --match-type MATCH_TYPE --response RESPONSE --regex REGEX --negate --targets --username USERNAME --password PASSWORD --token PASSWORD
+```