github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/openstack/r/lb_pool_v2.html.markdown (about)

     1  ---
     2  layout: "openstack"
     3  page_title: "OpenStack: openstack_lb_pool_v2"
     4  sidebar_current: "docs-openstack-resource-lbaas-pool-v2"
     5  description: |-
     6    Manages a V2 pool resource within OpenStack.
     7  ---
     8  
     9  # openstack\_lbaas\_pool\_v2
    10  
    11  Manages a V2 pool resource within OpenStack.
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  resource "openstack_lb_pool_v2" "pool_1" {
    17    protocol    = "ProtocolHTTP"
    18    lb_method   = "ROUND_ROBIN"
    19    listener_id = "d9415786-5f1a-428b-b35f-2f1523e146d2"
    20  
    21    persistence {
    22      type        = "HTTP_COOKIE"
    23      cookie_name = "testCookie"
    24    }
    25  }
    26  ```
    27  
    28  ## Argument Reference
    29  
    30  The following arguments are supported:
    31  
    32  * `region` - (Required) The region in which to obtain the V2 Networking client.
    33      A Networking client is needed to create an . If omitted, the
    34      `OS_REGION_NAME` environment variable is used. Changing this creates a new
    35      pool.
    36  
    37  * `tenant_id` - (Optional) Required for admins. The UUID of the tenant who owns
    38      the pool.  Only administrative users can specify a tenant UUID
    39      other than their own. Changing this creates a new pool.
    40  
    41  * `name` - (Optional) Human-readable name for the pool.
    42  
    43  * `description` - (Optional) Human-readable description for the pool.
    44  
    45  * `protocol` = (Required) The protocol - can either be TCP, HTTP or HTTPS.
    46      Changing this creates a new pool.
    47  
    48  * `loadbalancer_id` - (Optional) The load balancer on which to provision this
    49      pool. Changing this creates a new pool.
    50      Note:  One of LoadbalancerID or ListenerID must be provided.
    51  
    52  * `listener_id` - (Optional) The Listener on which the members of the pool
    53      will be associated with. Changing this creates a new pool.
    54  	Note:  One of LoadbalancerID or ListenerID must be provided.
    55  
    56  * `lb_method` - (Required) The load balancing algorithm to
    57      distribute traffic to the pool's members. Must be one of
    58      ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    59  
    60  * `persistence` - Omit this field to prevent session persistence.  Indicates
    61      whether connections in the same session will be processed by the same Pool
    62      member or not. Changing this creates a new pool.
    63  
    64  * `admin_state_up` - (Optional) The administrative state of the pool.
    65      A valid value is true (UP) or false (DOWN).
    66  
    67  The `persistence` argument supports:
    68  
    69  * `type` - (Required) The type of persistence mode. The current specification
    70      supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    71  
    72  * `cookie_name` - (Required) The name of the cookie if persistence mode is set
    73      appropriately.
    74  
    75  ## Attributes Reference
    76  
    77  The following attributes are exported:
    78  
    79  * `id` - The unique ID for the pool.
    80  * `tenant_id` - See Argument Reference above.
    81  * `name` - See Argument Reference above.
    82  * `description` - See Argument Reference above.
    83  * `protocol` - See Argument Reference above.
    84  * `lb_method` - See Argument Reference above.
    85  * `persistence` - See Argument Reference above.
    86  * `admin_state_up` - See Argument Reference above.