github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/website/source/docs/providers/openstack/r/lb_vip_v1.html.markdown (about)

     1  ---
     2  layout: "openstack"
     3  page_title: "OpenStack: openstack_lb_vip_v1"
     4  sidebar_current: "docs-openstack-resource-lb-vip-v1"
     5  description: |-
     6    Manages a V1 load balancer vip resource within OpenStack.
     7  ---
     8  
     9  # openstack\_lb\_vip_v1
    10  
    11  Manages a V1 load balancer vip resource within OpenStack.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "openstack_lb_vip_v1" "vip_1" {
    17    name = "tf_test_lb_vip"
    18    subnet_id = "12345"
    19    protocol = "HTTP"
    20    port = 80
    21    pool_id = "67890"
    22  }
    23  ```
    24  
    25  ## Argument Reference
    26  
    27  The following arguments are supported:
    28  
    29  * `region` - (Required) The region in which to obtain the V2 Networking client.
    30      A Networking client is needed to create a VIP. If omitted, the
    31      `OS_REGION_NAME` environment variable is used. Changing this creates a new
    32      VIP.
    33  
    34  * `name` - (Required) The name of the vip. Changing this updates the name of
    35      the existing vip.
    36  
    37  * `subnet_id` - (Required) The network on which to allocate the vip's address. A
    38      tenant can only create vips on networks authorized by policy (e.g. networks
    39      that belong to them or networks that are shared). Changing this creates a
    40      new vip.
    41  
    42  * `protocol` - (Required)  The protocol - can be either 'TCP, 'HTTP', or
    43      HTTPS'. Changing this creates a new vip.
    44  
    45  * `port` - (Required) The port on which to listen for client traffic. Changing
    46      this creates a new vip.
    47  
    48  * `pool_id` - (Required) The ID of the pool with which the vip is associated.
    49      Changing this updates the pool_id of the existing vip.
    50  
    51  * `tenant_id` - (Optional) The owner of the vip. Required if admin wants to
    52      create a vip member for another tenant. Changing this creates a new vip.
    53  
    54  * `address` - (Optional)  The IP address of the vip. Changing this creates a new
    55      vip.
    56  
    57  * `description` - (Optional) Human-readable description for the vip. Changing
    58      this updates the description of the existing vip.
    59  
    60  * `persistence` - (Optional) Omit this field to prevent session persistence.
    61      The persistence object structure is documented below. Changing this updates
    62      the persistence of the existing vip.
    63  
    64  * `conn_limit` - (Optional) The maximum number of connections allowed for the
    65      vip. Default is -1, meaning no limit. Changing this updates the conn_limit
    66      of the existing vip.
    67  
    68  * `floating_ip` - (Optional) A *Networking* Floating IP that will be associated
    69      with the vip. The Floating IP must be provisioned already.
    70  
    71  * `admin_state_up` - (Optional) The administrative state of the vip.
    72      Acceptable values are "true" and "false". Changing this value updates the
    73      state of the existing vip.
    74  
    75  The `persistence` block supports:
    76  
    77  * `type` - (Required) The type of persistence mode. Valid values are "SOURCE_IP",
    78      "HTTP_COOKIE", or "APP_COOKIE".
    79  
    80  * `cookie_name` - (Optional) The name of the cookie if persistence mode is set
    81      appropriately.
    82  
    83  ## Attributes Reference
    84  
    85  The following attributes are exported:
    86  
    87  * `region` - See Argument Reference above.
    88  * `name` - See Argument Reference above.
    89  * `subnet_id` - See Argument Reference above.
    90  * `protocol` - See Argument Reference above.
    91  * `port` - See Argument Reference above.
    92  * `pool_id` - See Argument Reference above.
    93  * `tenant_id` - See Argument Reference above.
    94  * `address` - See Argument Reference above.
    95  * `description` - See Argument Reference above.
    96  * `persistence` - See Argument Reference above.
    97  * `conn_limit` - See Argument Reference above.
    98  * `floating_ip` - See Argument Reference above.
    99  * `admin_state_up` - See Argument Reference above.
   100  * `port_id` - Port UUID for this VIP at associated floating IP (if any).