attach

Attach a NIC to a Load Balancer

Usage

ionosctl compute loadbalancer nic attach [flags]

Aliases

For loadbalancer command:

[lb]

For nic command:

[n]

For attach command:

[a]

Description

Use this command to add a server NIC to a Load Balancer's backend pool. The NIC's server then receives a share of the traffic the balancer distributes.

On attach, the NIC inherits the Load Balancer's public IPv4 address (the balanced, public-facing IP that all backends share). A NIC can be attached to only one Load Balancer at a time; the NIC and Load Balancer must live in the same Data Center.

The NIC is identified by --datacenter-id and --nic-id. --server-id is optional and used only to narrow shell completion of --nic-id to a single server.

Use --wait (-w) to wait for the NIC to reach AVAILABLE state before returning.

Required values to run command:

• Data Center Id

• Load Balancer Id

• NIC Id

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")
      --cols strings             Set of columns to be printed on output 
                                 Available columns: [NicId Name Dhcp LanId Ips IPv6Ips State FirewallActive FirewallType DeviceNumber PciSlot Mac DHCPv6 IPv6CidrBlock]
  -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 int                Level of detail for response objects (default 1)
  -F, --filters strings          Limit results to results containing the specified filter:KEY1=VALUE1,KEY2=VALUE2
  -f, --force                    Force command to execute without user input
  -h, --help                     Print usage
      --limit int                Maximum number of items to return per request (default 50)
      --loadbalancer-id string   The unique Load Balancer Id (required)
  -i, --nic-id string            The unique NIC Id (required)
      --no-headers               Don't print table headers when table output is used
      --offset int               Number of items to skip before starting to collect the results
      --order-by string          Property to order the results by
  -o, --output string            Desired output format [text|json|api-json] (default "text")
      --query string             JMESPath query string to filter the output
  -q, --quiet                    Quiet output
      --server-id string         The unique Id of the Server the NIC belongs to. Not required to attach; providing it narrows --nic-id completion to that server's NICs
  -t, --timeout int              Timeout in seconds for --wait and other wait operations (default 600)
  -v, --verbose count            Increase verbosity level [-v, -vv, -vvv]
  -w, --wait                     Wait for the resource to reach AVAILABLE state after the command completes. No-op for list commands

Examples

# Attach a NIC to a Load Balancer (server-id speeds up NIC completion)
ionosctl compute loadbalancer nic attach --datacenter-id DATACENTER_ID --server-id SERVER_ID --loadbalancer-id LOADBALANCER_ID --nic-id NIC_ID

# Attach and wait for the NIC to become AVAILABLE
ionosctl compute loadbalancer nic attach --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --nic-id NIC_ID --wait