Back to godoc.org

Package routers

v1.0.0
Latest Go to latest

The highest tagged major version is .

Published: Oct 28, 2014 | License: Apache-2.0 | Module: github.com/rackspace/gophercloud

Index

func List

func List(c *gophercloud.ServiceClient, opts ListOpts) pagination.Pager

List returns a Pager which allows you to iterate over a collection of routers. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those routers that are owned by the tenant who submits the request, unless an admin user submits the request.

type CreateOpts

type CreateOpts struct {
	Name         string
	AdminStateUp *bool
	TenantID     string
	GatewayInfo  *GatewayInfo
}

CreateOpts contains all the values needed to create a new router. There are no required values.

type CreateResult

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult represents the result of a create operation.

func Create

func Create(c *gophercloud.ServiceClient, opts CreateOpts) CreateResult

Create accepts a CreateOpts struct and uses the values to create a new logical router. When it is created, the router does not have an internal interface - it is not associated to any subnet.

You can optionally specify an external gateway for a router using the GatewayInfo struct. The external gateway for the router must be plugged into an external network (it is external if its `router:external' field is set to true).

func (CreateResult) Extract

func (r CreateResult) Extract() (*Router, error)

Extract is a function that accepts a result and extracts a router.

type DeleteResult

type DeleteResult struct {
	gophercloud.ErrResult
}

DeleteResult represents the result of a delete operation.

func Delete

func Delete(c *gophercloud.ServiceClient, id string) DeleteResult

Delete will permanently delete a particular router based on its unique ID.

type GatewayInfo

type GatewayInfo struct {
	NetworkID string `json:"network_id" mapstructure:"network_id"`
}

GatewayInfo represents the information of an external gateway for any particular network router.

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult represents the result of a get operation.

func Get

func Get(c *gophercloud.ServiceClient, id string) GetResult

Get retrieves a particular router based on its unique ID.

func (GetResult) Extract

func (r GetResult) Extract() (*Router, error)

Extract is a function that accepts a result and extracts a router.

type InterfaceInfo

type InterfaceInfo struct {
	// The ID of the subnet which this interface is associated with.
	SubnetID string `json:"subnet_id" mapstructure:"subnet_id"`

	// The ID of the port that is a part of the subnet.
	PortID string `json:"port_id" mapstructure:"port_id"`

	// The UUID of the interface.
	ID string `json:"id" mapstructure:"id"`

	// Owner of the interface.
	TenantID string `json:"tenant_id" mapstructure:"tenant_id"`
}

InterfaceInfo represents information about a particular router interface. As mentioned above, in order for a router to forward to a subnet, it needs an interface.

type InterfaceOpts

type InterfaceOpts struct {
	SubnetID string
	PortID   string
}

InterfaceOpts allow you to work with operations that either add or remote an internal interface from a router.

type InterfaceResult

type InterfaceResult struct {
	gophercloud.Result
}

InterfaceResult represents the result of interface operations, such as AddInterface() and RemoveInterface().

func AddInterface

func AddInterface(c *gophercloud.ServiceClient, id string, opts InterfaceOpts) InterfaceResult

AddInterface attaches a subnet to an internal router interface. You must specify either a SubnetID or PortID in the request body. If you specify both, the operation will fail and an error will be returned.

If you specify a SubnetID, the gateway IP address for that particular subnet is used to create the router interface. Alternatively, if you specify a PortID, the IP address associated with the port is used to create the router interface.

If you reference a port that is associated with multiple IP addresses, or if the port is associated with zero IP addresses, the operation will fail and a 400 Bad Request error will be returned.

If you reference a port already in use, the operation will fail and a 409 Conflict error will be returned.

The PortID that is returned after using Extract() on the result of this operation can either be the same PortID passed in or, on the other hand, the identifier of a new port created by this operation. After the operation completes, the device ID of the port is set to the router ID, and the device owner attribute is set to `network:router_interface'.

func RemoveInterface

func RemoveInterface(c *gophercloud.ServiceClient, id string, opts InterfaceOpts) InterfaceResult

RemoveInterface removes an internal router interface, which detaches a subnet from the router. You must specify either a SubnetID or PortID, since these values are used to identify the router interface to remove.

Unlike AddInterface, you can also specify both a SubnetID and PortID. If you choose to specify both, the subnet ID must correspond to the subnet ID of the first IP address on the port specified by the port ID. Otherwise, the operation will fail and return a 409 Conflict error.

If the router, subnet or port which are referenced do not exist or are not visible to you, the operation will fail and a 404 Not Found error will be returned. After this operation completes, the port connecting the router with the subnet is removed from the subnet for the network.

func (InterfaceResult) Extract

func (r InterfaceResult) Extract() (*InterfaceInfo, error)

Extract is a function that accepts a result and extracts an information struct.

type ListOpts

type ListOpts struct {
	ID           string `q:"id"`
	Name         string `q:"name"`
	AdminStateUp *bool  `q:"admin_state_up"`
	Status       string `q:"status"`
	TenantID     string `q:"tenant_id"`
	Limit        int    `q:"limit"`
	Marker       string `q:"marker"`
	SortKey      string `q:"sort_key"`
	SortDir      string `q:"sort_dir"`
}

ListOpts allows the filtering and sorting of paginated collections through the API. Filtering is achieved by passing in struct field values that map to the floating IP attributes you want to see returned. SortKey allows you to sort by a particular network attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

type Router

type Router struct {
	// Indicates whether or not a router is currently operational.
	Status string `json:"status" mapstructure:"status"`

	// Information on external gateway for the router.
	GatewayInfo GatewayInfo `json:"external_gateway_info" mapstructure:"external_gateway_info"`

	// Administrative state of the router.
	AdminStateUp bool `json:"admin_state_up" mapstructure:"admin_state_up"`

	// Human readable name for the router. Does not have to be unique.
	Name string `json:"name" mapstructure:"name"`

	// Unique identifier for the router.
	ID string `json:"id" mapstructure:"id"`

	// Owner of the router. Only admin users can specify a tenant identifier
	// other than its own.
	TenantID string `json:"tenant_id" mapstructure:"tenant_id"`
}

Router represents a Neutron router. A router is a logical entity that forwards packets across internal subnets and NATs (network address translation) them on external networks through an appropriate gateway.

A router has an interface for each subnet with which it is associated. By default, the IP address of such interface is the subnet's gateway IP. Also, whenever a router is associated with a subnet, a port for that router interface is added to the subnet's network.

func ExtractRouters

func ExtractRouters(page pagination.Page) ([]Router, error)

ExtractRouters accepts a Page struct, specifically a RouterPage struct, and extracts the elements into a slice of Router structs. In other words, a generic collection is mapped into a relevant slice.

type RouterPage

type RouterPage struct {
	pagination.LinkedPageBase
}

RouterPage is the page returned by a pager when traversing over a collection of routers.

func (RouterPage) IsEmpty

func (p RouterPage) IsEmpty() (bool, error)

IsEmpty checks whether a RouterPage struct is empty.

func (RouterPage) NextPageURL

func (p RouterPage) NextPageURL() (string, error)

NextPageURL is invoked when a paginated collection of routers has reached the end of a page and the pager seeks to traverse over a new one. In order to do this, it needs to construct the next page's URL.

type UpdateOpts

type UpdateOpts struct {
	Name         string
	AdminStateUp *bool
	GatewayInfo  *GatewayInfo
}

UpdateOpts contains the values used when updating a router.

type UpdateResult

type UpdateResult struct {
	// contains filtered or unexported fields
}

UpdateResult represents the result of an update operation.

func Update

func Update(c *gophercloud.ServiceClient, id string, opts UpdateOpts) UpdateResult

Update allows routers to be updated. You can update the name, administrative state, and the external gateway. For more information about how to set the external gateway for a router, see Create. This operation does not enable the update of router interfaces. To do this, use the AddInterface and RemoveInterface functions.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*Router, error)

Extract is a function that accepts a result and extracts a router.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier