90 lines
2.9 KiB
Markdown
90 lines
2.9 KiB
Markdown
|
---
|
||
|
|
layout: "openstack"
|
||
|
|
page_title: "OpenStack: openstack_lb_vip"
|
||
|
|
sidebar_current: "docs-openstack-resource-lb-vip"
|
||
|
|
description: |-
|
||
|
|
Manages a load balancer vip resource within OpenStack.
|
||
|
|
---
|
||
|
|
|
||
|
|
# openstack\_lb\_vip
|
||
|
|
|
||
|
|
Manages a load balancer vip resource within OpenStack.
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
```
|
||
|
|
resource "openstack_lb_vip" "vip_1" {
|
||
|
|
name = "tf_test_lb_vip"
|
||
|
|
subnet_id = "12345"
|
||
|
|
protocol = "HTTP"
|
||
|
|
port = 80
|
||
|
|
pool_id = "67890"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Argument Reference
|
||
|
|
|
||
|
|
The following arguments are supported:
|
||
|
|
|
||
|
|
* `name` - (Required) The name of the vip. Changing this updates the name of
|
||
|
|
the existing vip.
|
||
|
|
|
||
|
|
* `subnet_id` - (Required) The network on which to allocate the vip's address. A
|
||
|
|
tenant can only create vips on networks authorized by policy (e.g. networks
|
||
|
|
that belong to them or networks that are shared). Changing this creates a
|
||
|
|
new vip.
|
||
|
|
|
||
|
|
* `protocol` - (Required) The protocol - can be either 'TCP, 'HTTP', or
|
||
|
|
HTTPS'. Changing this creates a new vip.
|
||
|
|
|
||
|
|
* `port` - (Required) The port on which to listen for client traffic. Changing
|
||
|
|
this creates a new vip.
|
||
|
|
|
||
|
|
* `pool_id` - (Required) The ID of the pool with which the vip is associated.
|
||
|
|
Changing this updates the pool_id of the existing vip.
|
||
|
|
|
||
|
|
* `tenant_id` - (Optional) The owner of the vip. Required if admin wants to
|
||
|
|
create a vip member for another tenant. Changing this creates a new vip.
|
||
|
|
|
||
|
|
* `address` - (Optional) The IP address of the vip. Changing this creates a new
|
||
|
|
vip.
|
||
|
|
|
||
|
|
* `description` - (Optional) Human-readable description for the vip. Changing
|
||
|
|
this updates the description of the existing vip.
|
||
|
|
|
||
|
|
* `persistence` - (Optional) Omit this field to prevent session persistence.
|
||
|
|
The persistence object structure is documented below. Changing this updates
|
||
|
|
the persistence of the existing vip.
|
||
|
|
|
||
|
|
* `conn_limit` - (Optional) The maximum number of connections allowed for the
|
||
|
|
vip. Default is -1, meaning no limit. Changing this updates the conn_limit
|
||
|
|
of the existing vip.
|
||
|
|
|
||
|
|
* `admin_state_up` - (Optional) The administrative state of the vip.
|
||
|
|
Acceptable values are "true" and "false". Changing this value updates the
|
||
|
|
state of the existing vip.
|
||
|
|
|
||
|
|
The `persistence` block supports:
|
||
|
|
|
||
|
|
* `type` - (Required) The type of persistence mode. Valid values are "SOURCE_IP",
|
||
|
|
"HTTP_COOKIE", or "APP_COOKIE".
|
||
|
|
|
||
|
|
* `cookie_name` - (Optional) The name of the cookie if persistence mode is set
|
||
|
|
appropriately.
|
||
|
|
|
||
|
|
## Attributes Reference
|
||
|
|
|
||
|
|
The following attributes are exported:
|
||
|
|
|
||
|
|
* `name` - See Argument Reference above.
|
||
|
|
* `subnet_id` - See Argument Reference above.
|
||
|
|
* `protocol` - See Argument Reference above.
|
||
|
|
* `port` - See Argument Reference above.
|
||
|
|
* `pool_id` - See Argument Reference above.
|
||
|
|
* `tenant_id` - See Argument Reference above.
|
||
|
|
* `address` - See Argument Reference above.
|
||
|
|
* `description` - See Argument Reference above.
|
||
|
|
* `persistence` - See Argument Reference above.
|
||
|
|
* `conn_limit` - See Argument Reference above.
|
||
|
|
* `admin_state_up` - See Argument Reference above.
|