Documentation ¶
Overview ¶
Package listeners provides information and interaction with Listeners of the LBaaS v2 extension for the OpenStack Networking service.
Example to List Listeners
listOpts := listeners.ListOpts{ LoadbalancerID : "ca430f80-1737-4712-8dc6-3f640d55594b", } allPages, err := listeners.List(networkClient, listOpts).AllPages() if err != nil { panic(err) } allListeners, err := listeners.ExtractListeners(allPages) if err != nil { panic(err) } for _, listener := range allListeners { fmt.Printf("%+v\n", listener) }
Example to Create a Listener
createOpts := listeners.CreateOpts{ Protocol: "TCP", Name: "db", LoadbalancerID: "79e05663-7f03-45d2-a092-8b94062f22ab", AdminStateUp: gophercloud.Enabled, DefaultPoolID: "41efe233-7591-43c5-9cf7-923964759f9e", ProtocolPort: 3306, } listener, err := listeners.Create(networkClient, createOpts).Extract() if err != nil { panic(err) }
Example to Update a Listener
listenerID := "d67d56a6-4a86-4688-a282-f46444705c64" i1001 := 1001 updateOpts := listeners.UpdateOpts{ ConnLimit: &i1001, } listener, err := listeners.Update(networkClient, listenerID, updateOpts).Extract() if err != nil { panic(err) }
Example to Delete a Listener
listenerID := "d67d56a6-4a86-4688-a282-f46444705c64" err := listeners.Delete(networkClient, listenerID).ExtractErr() if err != nil { panic(err) }
Index ¶
- Variables
- func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
- type CreateOpts
- type CreateOptsBuilder
- type CreateResult
- type DeleteResult
- type GetResult
- type ListOpts
- type ListOptsBuilder
- type Listener
- type ListenerPage
- type LoadBalancerID
- type Protocol
- type UpdateOpts
- type UpdateOptsBuilder
- type UpdateResult
Constants ¶
This section is empty.
Variables ¶
var StringToJsonNull = []string{
"default_tls_container_ref",
"client_ca_tls_container_ref"}
Attributes allow set to Json null
Functions ¶
func List ¶
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
List returns a Pager which allows you to iterate over a collection of listeners. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.
Default policy settings return only those listeners that are owned by the tenant who submits the request, unless an admin user submits the request.
Types ¶
type CreateOpts ¶
type CreateOpts struct { // Human-readable name for the Listener. Does not have to be unique. Name string `json:"name,omitempty"` // TenantID is only required if the caller has an admin role and wants // to create a pool for another tenant. TenantID string `json:"tenant_id,omitempty"` // Human-readable description for the Listener. Description string `json:"description,omitempty"` // The protocol - can either be TCP, UDP,HTTP or HTTPS. Protocol Protocol `json:"protocol" required:"true"` // The port on which to listen for client traffic. ProtocolPort int `json:"protocol_port" required:"true"` // The maximum number of connections allowed for the Listener. ConnLimit *int `json:"connection_limit,omitempty"` // The load balancer on which to provision this listener. LoadbalancerID string `json:"loadbalancer_id" required:"true"` // The administrative state of the Listener. A valid value is true (UP) // or false (DOWN). AdminStateUp *bool `json:"admin_state_up,omitempty"` Http2Enable *bool `json:"http_2_enable,omitempty"` // The ID of the default pool with which the Listener is associated. DefaultPoolID string `json:"default_pool_id,omitempty"` // A reference to a Barbican container of TLS secrets. DefaultTlsContainerRef string `json:"default_tls_container_ref,omitempty"` // A list of references to TLS secrets. SniContainerRefs []string `json:"sni_container_refs,omitempty"` // // // client ca cert id ClientCaTlsContainerRef string `json:"client_ca_tls_container_ref,omitempty"` }
CreateOpts represents options for creating a listener.
func (CreateOpts) ToListenerCreateMap ¶
func (opts CreateOpts) ToListenerCreateMap() (map[string]interface{}, error)
ToListenerCreateMap builds a request body from CreateOpts.
type CreateOptsBuilder ¶
CreateOptsBuilder allows extensions to add additional parameters to the Create request.
type CreateResult ¶
type CreateResult struct {
// contains filtered or unexported fields
}
CreateResult represents the result of a create operation. Call its Extract method to interpret it as a Listener.
func Create ¶
func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
Create is an operation which provisions a new Listeners based on the configuration defined in the CreateOpts struct. Once the request is validated and progress has started on the provisioning process, a CreateResult will be returned.
Users with an admin role can create Listeners on behalf of other tenants by specifying a TenantID attribute different than their own.
type DeleteResult ¶
type DeleteResult struct {
gophercloud.ErrResult
}
DeleteResult represents the result of a delete operation. Call its ExtractErr method to determine if the request succeeded or failed.
func Delete ¶
func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult)
Delete will permanently delete a particular Listeners based on its unique ID.
type GetResult ¶
type GetResult struct {
// contains filtered or unexported fields
}
GetResult represents the result of a get operation. Call its Extract method to interpret it as a Listener.
func Get ¶
func Get(c *gophercloud.ServiceClient, id string) (r GetResult)
Get retrieves a particular Listeners based on its unique ID.
type ListOpts ¶
type ListOpts struct { ID string `q:"id"` Name string `q:"name"` Description string `q:"description"` DefaultPoolID string `q:"default_pool_id"` Protocol string `q:"protocol"` ProtocolPort int `q:"protocol_port"` Limit int `q:"limit"` Marker string `q:"marker"` PageReverse *bool `q:"page_reverse"` DefaultTlsContainerRef string `q:"default_tls_container_ref"` ClientCaTlsContainerRef string `q:"client_ca_tls_container_ref"` MemberAddress string `q:"member_address"` MemberDeviceID string `q:"member_device_id"` }
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 listener attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.
func (ListOpts) ToListenerListQuery ¶
ToListenerListQuery formats a ListOpts into a query string.
type ListOptsBuilder ¶
ListOptsBuilder allows extensions to add additional parameters to the List request.
type Listener ¶
type Listener struct { // The unique ID for the Listener. ID string `json:"id"` // Owner of the Listener. TenantID string `json:"tenant_id"` // Human-readable name for the Listener. Does not have to be unique. Name string `json:"name"` // Human-readable description for the Listener. Description string `json:"description"` // The protocol to loadbalance. A valid value is TCP, HTTP, or HTTPS. Protocol string `json:"protocol"` // The port on which to listen to client traffic that is associated with the // Loadbalancer. A valid value is from 0 to 65535. ProtocolPort int `json:"protocol_port"` // The UUID of default pool. Must have compatible protocol with listener. DefaultPoolID *string `json:"default_pool_id"` // A list of load balancer IDs. Loadbalancers []LoadBalancerID `json:"loadbalancers"` // The maximum number of connections allowed for the Loadbalancer. // Default is -1, meaning no limit. ConnLimit int `json:"connection_limit"` // The list of references to TLS secrets. SniContainerRefs []string `json:"sni_container_refs"` // A reference to a Barbican container of TLS secrets. DefaultTlsContainerRef *string `json:"default_tls_container_ref"` // The administrative state of the Listener. A valid value is true (UP) or false (DOWN). AdminStateUp bool `json:"admin_state_up"` // tags for Listener Tags []string `json:"tags"` // client ca cert id ClientCaTlsContainerRef *string `json:"client_ca_tls_container_ref"` // CreatedAt is the time at which listeners has been created. CreatedAt string `json:"created_at"` // UpdatedAt is the time at which listeners has been created. UpdatedAt string `json:"updated_at"` }
Listener is the primary load balancing configuration object that specifies the loadbalancer and port on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc.
func ExtractListeners ¶
func ExtractListeners(r pagination.Page) ([]Listener, error)
ExtractListeners accepts a Page struct, specifically a ListenerPage struct, and extracts the elements into a slice of Listener structs. In other words, a generic collection is mapped into a relevant slice.
type ListenerPage ¶
type ListenerPage struct {
pagination.LinkedPageBase
}
ListenerPage is the page returned by a pager when traversing over a collection of listeners.
func (ListenerPage) IsEmpty ¶
func (r ListenerPage) IsEmpty() (bool, error)
IsEmpty checks whether a ListenerPage struct is empty.
func (ListenerPage) NextPageURL ¶
func (r ListenerPage) NextPageURL() (string, error)
NextPageURL is invoked when a paginated collection of listeners 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 LoadBalancerID ¶
type LoadBalancerID struct {
ID string `json:"id"`
}
type UpdateOpts ¶
type UpdateOpts struct { // Human-readable name for the Listener. Does not have to be unique. Name string `json:"name,omitempty"` // Human-readable description for the Listener. Description string `json:"description,omitempty"` // The maximum number of connections allowed for the Listener. ConnLimit *int `json:"connection_limit,omitempty"` // related pool id DefaultPoolID *string `json:"default_pool_id,omitempty"` // default container cert id DefaultTlsContainerRef *string `json:"default_tls_container_ref,omitempty"` // client container cert id ClientCaTlsContainerRef *string `json:"client_ca_tls_container_ref,omitempty"` // A list of references to TLS secrets. SniContainerRefs *[]string `json:"sni_container_refs,omitempty"` }
UpdateOpts represents options for updating a Listener.
func (UpdateOpts) ToListenerUpdateMap ¶
func (opts UpdateOpts) ToListenerUpdateMap() (map[string]interface{}, error)
ToListenerUpdateMap builds a request body from UpdateOpts.
type UpdateOptsBuilder ¶
UpdateOptsBuilder allows extensions to add additional parameters to the Update request.
type UpdateResult ¶
type UpdateResult struct {
// contains filtered or unexported fields
}
UpdateResult represents the result of an update operation. Call its Extract method to interpret it as a Listener.
func Update ¶
func Update(c *gophercloud.ServiceClient, id string, opts UpdateOpts) (r UpdateResult)
Update is an operation which modifies the attributes of the specified Listener.