github.com/adrian-bl/terraform@v0.7.0-rc2.0.20160705220747-de0a34fc3517/website/source/docs/providers/openstack/r/compute_secgroup_v2.html.markdown (about)

     1  ---
     2  layout: "openstack"
     3  page_title: "OpenStack: openstack_compute_secgroup_v2"
     4  sidebar_current: "docs-openstack-resource-compute-secgroup-v2"
     5  description: |-
     6    Manages a V2 security group resource within OpenStack.
     7  ---
     8  
     9  # openstack\_compute\_secgroup_v2
    10  
    11  Manages a V2 security group resource within OpenStack.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "openstack_compute_secgroup_v2" "secgroup_1" {
    17    name = "my_secgroup"
    18    description = "my security group"
    19    rule {
    20      from_port = 22
    21      to_port = 22
    22      ip_protocol = "tcp"
    23      cidr = "0.0.0.0/0"
    24    }
    25    rule {
    26      from_port = 80
    27      to_port = 80
    28      ip_protocol = "tcp"
    29      cidr = "0.0.0.0/0"
    30    }
    31  }
    32  ```
    33  
    34  ## Argument Reference
    35  
    36  The following arguments are supported:
    37  
    38  * `region` - (Required) The region in which to obtain the V2 Compute client.
    39      A Compute client is needed to create a security group. If omitted, the
    40      `OS_REGION_NAME` environment variable is used. Changing this creates a new
    41      security group.
    42  
    43  * `name` - (Required) A unique name for the security group. Changing this
    44      updates the `name` of an existing security group.
    45  
    46  * `description` - (Required) A description for the security group. Changing this
    47      updates the `description` of an existing security group.
    48  
    49  * `rule` - (Optional) A rule describing how the security group operates. The
    50      rule object structure is documented below. Changing this updates the
    51      security group rules. As shown in the example above, multiple rule blocks
    52      may be used.
    53  
    54  The `rule` block supports:
    55  
    56  * `from_port` - (Required) An integer representing the lower bound of the port
    57  range to open. Changing this creates a new security group rule.
    58  
    59  * `to_port` - (Required) An integer representing the upper bound of the port
    60  range to open. Changing this creates a new security group rule.
    61  
    62  * `ip_protocol` - (Required) The protocol type that will be allowed. Changing
    63  this creates a new security group rule.
    64  
    65  * `cidr` - (Optional) Required if `from_group_id` or `self` is empty. The IP range
    66  that will be the source of network traffic to the security group. Use 0.0.0.0/0
    67  to allow all IP addresses. Changing this creates a new security group rule. Cannot
    68  be combined with `from_group_id` or `self`.
    69  
    70  * `from_group_id` - (Optional) Required if `cidr` or `self` is empty. The ID of a
    71  group from which to forward traffic to the parent group. Changing this creates a
    72  new security group rule. Cannot be combined with `cidr` or `self`.
    73  
    74  * `self` - (Optional) Required if `cidr` and `from_group_id` is empty. If true,
    75  the security group itself will be added as a source to this ingress rule. Cannot
    76  be combined with `cidr` or `from_group_id`.
    77  
    78  ## Attributes Reference
    79  
    80  The following attributes are exported:
    81  
    82  * `region` - See Argument Reference above.
    83  * `name` - See Argument Reference above.
    84  * `description` - See Argument Reference above.
    85  * `rule` - See Argument Reference above.
    86  
    87  ## Notes
    88  
    89  ### ICMP Rules
    90  
    91  When using ICMP as the `ip_protocol`, the `from_port` sets the ICMP _type_ and the `to_port` sets the ICMP _code_. To allow all ICMP types, set each value to `-1`, like so:
    92  
    93  ```
    94  rule {
    95    from_port = -1
    96    to_port = -1
    97    ip_protocol = "icmp"
    98    cidr = "0.0.0.0/0"
    99  }
   100  ```
   101  
   102  A list of ICMP types and codes can be found [here](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages).
   103  
   104  ### Referencing Security Groups
   105  
   106  When referencing a security group in a configuration (for example, a configuration creates a new security group and then needs to apply it to an instance being created in the same configuration), it is currently recommended to reference the security group by name and not by ID, like this:
   107  
   108  ```
   109  resource "openstack_compute_instance_v2" "test-server" {
   110    name = "tf-test"
   111    image_id = "ad091b52-742f-469e-8f3c-fd81cadf0743"
   112    flavor_id = "3"
   113    key_pair = "my_key_pair_name"
   114    security_groups = ["${openstack_compute_secgroup_v2.secgroup_1.name}"]
   115  }
   116  ```