add

Add a Network Load Balancer Forwarding Rule Target

Usage

ionosctl networkloadbalancer rule target add [flags]

Aliases

For rule command:

[r forwardingrule]

For target command:

[t]

For add command:

[a]

Description

Use this command to add a Forwarding Rule Target in a specified Network Load Balancer Forwarding Rule. You can also set Health Check Settings for Forwarding Rule Target. The Check parameter for Health Check Settings specifies whether the target VM's health is checked. If turned off, a target VM is always considered available. If turned on, the target VM is available when accepting periodic TCP connections, to ensure that it is really able to serve requests. The address and port to send the tests to are those of the target VM. The health check only consists of a connection attempt.

Regarding the Weight parameter, this parameter is used to adjust the target VM's weight relative to other target VMs. All target VMs will receive a load proportional to their weight relative to the sum of all weights, so the higher the weight, the higher the load. The default weight is 1, and the maximal value is 256. A value of 0 means the target VM will not participate in load-balancing but will still accept persistent connections. If this parameter is used to distribute the load according to target VM's capacity, it is recommended to start with values which can both grow and shrink, for instance between 10 and 100 to leave enough room above and below for later adjustments.

You can wait for the Request to be executed using --wait-for-request option.

Required values to run command:

• Data Center Id

• Network Load Balancer Id

• Forwarding Rule Id

• Target Ip

• Target Port

Options

  -u, --api-url string                  Override default host URL. Preferred over the config file override 'cloud' and env var 'IONOS_API_URL' (default "https://api.ionos.com")
      --check                           [Health Check] Check specifies whether the target VM's health is checked (default true)
      --check-interval int              [Health Check] CheckInterval determines the duration (in milliseconds) between consecutive health checks (default 2000)
      --cols strings                    Set of columns to be printed on output 
                                        Available columns: [TargetIp TargetPort Weight Check CheckInterval Maintenance] (default [TargetIp,TargetPort,Weight,Check,CheckInterval,Maintenance])
  -c, --config string                   Configuration file used for authentication (default "$XDG_CONFIG_HOME/ionosctl/config.yaml")
      --datacenter-id string            The unique Data Center Id (required)
  -D, --depth int32                     Controls the detail depth of the response objects. Max depth is 10.
  -f, --force                           Force command to execute without user input
  -h, --help                            Print usage
      --ip ip                           IP of a balanced target VM (required)
      --limit int                       Pagination limit: Maximum number of items to return per request (default 50)
      --maintenance                     [Health Check]  Maintenance specifies if a target VM should be marked as down, even if it is not
      --networkloadbalancer-id string   The unique NetworkLoadBalancer Id (required)
      --no-headers                      Don't print table headers when table output is used
      --offset int                      Pagination offset: Number of items to skip before starting to collect the results
  -o, --output string                   Desired output format [text|json|api-json] (default "text")
  -P, --port string                     Port of the balanced target service. Range: 1 to 65535 (required)
      --query string                    JMESPath query string to filter the output
  -q, --quiet                           Quiet output
      --rule-id string                  The unique ForwardingRule Id (required)
  -t, --timeout int                     Timeout option for Request for Forwarding Rule Target creation [seconds] (default 300)
  -v, --verbose count                   Increase verbosity level [-v, -vv, -vvv]
  -w, --wait-for-request                Wait for the Request for Forwarding Rule Target creation to be executed
  -W, --weight int                      Weight parameter is used to adjust the target VM's weight relative to other target VMs. Maximum: 256 (default 1)

Examples

ionosctl networkloadbalancer rule target add --datacenter-id DATACENTER_ID --networkloadbalancer-id NETWORKLOADBALANCER_ID --rule-id FORWARDINGRULE_ID --ip TARGET_IP --port TARGET_PORT