Documentation

quantum_router_gateway - set/unset a gateway interface for the router with the specified external network

DEPRECATED

Deprecated in 2.0. Use os_router instead

Synopsis

Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.

Requirements (on host that executes module)

  • python >= 2.6
  • python-neutronclient or python-quantumclient
  • python-keystoneclient

Options

parameter required default choices comments
auth_url
 no http://127.0.0.1:35357/v2.0/
    The keystone URL for authentication
    login_password
    		 yes yes
      Password of login user
      login_tenant_name
      		 yes yes
        The tenant name of the login user
        login_username
        		 yes admin
          login username to authenticate to keystone
          network_name
          		 yes None
            Name of the external network which should be attached to the router.
            region_name
            		 no None
              Name of the region
              router_name
              		 yes None
                Name of the router to which the gateway should be attached.
                state
                		 no present
                • present
                • absent
                Indicate desired state of the resource

                Examples

                # Attach an external network with a router to allow flow of external traffic
- quantum_router_gateway: state=present login_username=admin login_password=admin
                          login_tenant_name=admin router_name=external_router
                          network_name=external_network

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