Documentation

os_subnet - Add/Remove subnet to an OpenStack network

New in version 2.0.

Synopsis

Add or Remove a subnet to an OpenStack network

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

Options

parameter required default choices comments
allocation_pool_end
no None
    From the subnet pool the last IP that should be assigned to the virtual machines.
    allocation_pool_start
    no None
      From the subnet pool the starting address from which the IP should be allocated.
      api_timeout
      no None
        How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
        auth
        no
          Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
          auth_type
          no password
            Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
            availability_zone
            no
              Name of the availability zone.
              cacert
              no None
                A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
                cert
                no None
                  A path to a client certificate to use as part of the SSL transaction
                  cidr
                  no None
                    The CIDR representation of the subnet that should be assigned to the subnet. Required when state is 'present'
                    cloud
                    no
                      Named cloud to operate against. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present.
                      dns_nameservers
                      no None
                        List of DNS nameservers for this subnet.
                        enable_dhcp
                        no True
                          Whether DHCP should be enabled for this subnet.
                          endpoint_type
                          no public
                          • public
                          • internal
                          • admin
                          Endpoint URL type to fetch from the service catalog.
                          gateway_ip
                          no None
                            The ip that would be assigned to the gateway for this subnet
                            host_routes
                            no None
                              A list of host route dictionaries for the subnet.
                              ip_version
                              no 4
                                The IP version of the subnet 4 or 6
                                ipv6_address_mode
                                no None
                                • dhcpv6-stateful
                                • dhcpv6-stateless
                                • slaac
                                IPv6 address mode
                                ipv6_ra_mode
                                no None
                                • dhcpv6-stateful
                                • dhcpv6-stateless
                                • slaac
                                IPv6 router advertisement mode
                                key
                                no None
                                  A path to a client key to use as part of the SSL transaction
                                  name
                                  yes
                                    The name of the subnet that should be created. Although Neutron allows for non-unique subnet names, this module enforces subnet name uniqueness.
                                    network_name
                                    no
                                      Name of the network to which the subnet should be attached
                                      requried when state is 'present'
                                      region_name
                                      no
                                        Name of the region.
                                        state
                                        no present
                                        • present
                                        • absent
                                        Indicate desired state of the resource
                                        timeout
                                        no 180
                                          How long should ansible wait for the requested resource.
                                          validate_certs
                                          no True
                                            Whether or not SSL API requests should be verified.

                                            aliases: verify
                                            wait
                                            no yes
                                            • yes
                                            • no
                                            Should ansible wait until the requested resource is complete.

                                            Examples

                                            # Create a new (or update an existing) subnet on the specified network
                                            - os_subnet:
                                                state: present
                                                network_name: network1
                                                name: net1subnet
                                                cidr: 192.168.0.0/24
                                                dns_nameservers:
                                                   - 8.8.8.7
                                                   - 8.8.8.8
                                                host_routes:
                                                   - destination: 0.0.0.0/0
                                                     nexthop: 12.34.56.78
                                                   - destination: 192.168.0.0/24
                                                     nexthop: 192.168.0.1
                                            
                                            # Delete a subnet
                                            - os_subnet:
                                                state: absent
                                                name: net1subnet
                                            
                                            # Create an ipv6 stateless subnet
                                            - os_subnet:
                                                state: present
                                                name: intv6
                                                network_name: internal
                                                ip_version: 6
                                                cidr: 2db8:1::/64
                                                dns_nameservers:
                                                    - 2001:4860:4860::8888
                                                    - 2001:4860:4860::8844
                                                ipv6_ra_mode: dhcpv6-stateless
                                                ipv6_address_mode: dhcpv6-stateless
                                            

                                            Notes

                                            Note

                                            The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

                                            Note

                                            Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config

                                            This is a Core Module

                                            For more information on what this means please read Core Modules

                                            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.