rules

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package rules enables management and retrieval of Firewall Rules in the OpenStack Networking Service.

Example to List Rules 

listOpts := rules.ListOpts{
	Protocol: rules.ProtocolAny,
}

allPages, err := rules.List(networkClient, listOpts).AllPages()
if err != nil {
	panic(err)
}

allRules, err := rules.ExtractRules(allPages)
if err != nil {
	panic(err)
}

for _, rule := range allRules {
	fmt.Printf("%+v\n", rule)
}

Example to Create a Rule 

createOpts := rules.CreateOpts{
	Action:               "allow",
	Protocol:             rules.ProtocolTCP,
	Description:          "ssh",
	DestinationPort:      22,
	DestinationIPAddress: "192.168.1.0/24",
}

rule, err := rules.Create(networkClient, createOpts).Extract()
if err != nil {
	panic(err)
}

Example to Update a Rule 

ruleID := "f03bd950-6c56-4f5e-a307-45967078f507"
newPort := 80
newDescription := "http"

updateOpts := rules.UpdateOpts{
	Description: &newDescription,
	port:        &newPort,
}

rule, err := rules.Update(networkClient, ruleID, updateOpts).Extract()
if err != nil {
	panic(err)
}

Example to Delete a Rule 

ruleID := "f03bd950-6c56-4f5e-a307-45967078f507"
err := rules.Delete(networkClient, ruleID).ExtractErr()
if err != nil {
	panic(err)
}

Index

Constants

This section is empty.

Variables

This section is empty.

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 firewall rules. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

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

Types

type CreateOpts 

type CreateOpts struct {
	Protocol             Protocol              `json:"protocol" required:"true"`
	Action               string                `json:"action" required:"true"`
	TenantID             string                `json:"tenant_id,omitempty"`
	ProjectID            string                `json:"project_id,omitempty"`
	Name                 string                `json:"name,omitempty"`
	Description          string                `json:"description,omitempty"`
	IPVersion            gophercloud.IPVersion `json:"ip_version,omitempty"`
	SourceIPAddress      string                `json:"source_ip_address,omitempty"`
	DestinationIPAddress string                `json:"destination_ip_address,omitempty"`
	SourcePort           string                `json:"source_port,omitempty"`
	DestinationPort      string                `json:"destination_port,omitempty"`
	Shared               *bool                 `json:"shared,omitempty"`
	Enabled              *bool                 `json:"enabled,omitempty"`
}

CreateOpts contains all the values needed to create a new firewall rule.

func (CreateOpts) ToRuleCreateMap 

func (opts CreateOpts) ToRuleCreateMap() (map[string]interface{}, error)

ToRuleCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder 

type CreateOptsBuilder interface {
	ToRuleCreateMap() (map[string]interface{}, error)
}

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 Rule.

func Create 

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

Create accepts a CreateOpts struct and uses the values to create a new firewall rule.

func (CreateResult) Extract 

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

Extract is a function that accepts a result and extracts a firewall rule.

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 firewall rule 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 Rule.

func Get 

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

Get retrieves a particular firewall rule based on its unique ID.

func (GetResult) Extract 

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

Extract is a function that accepts a result and extracts a firewall rule.

type ListOpts 

type ListOpts struct {
	TenantID             string `q:"tenant_id"`
	ProjectID            string `q:"project_id"`
	Name                 string `q:"name"`
	Description          string `q:"description"`
	Protocol             string `q:"protocol"`
	Action               string `q:"action"`
	IPVersion            int    `q:"ip_version"`
	SourceIPAddress      string `q:"source_ip_address"`
	DestinationIPAddress string `q:"destination_ip_address"`
	SourcePort           string `q:"source_port"`
	DestinationPort      string `q:"destination_port"`
	Enabled              bool   `q:"enabled"`
	ID                   string `q:"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 Firewall rule attributes you want to see returned. SortKey allows you to sort by a particular firewall rule attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

func (ListOpts) ToRuleListQuery 

func (opts ListOpts) ToRuleListQuery() (string, error)

ToRuleListQuery formats a ListOpts into a query string.

type ListOptsBuilder 

type ListOptsBuilder interface {
	ToRuleListQuery() (string, error)
}

ListOptsBuilder allows extensions to add additional parameters to the List request.

type Protocol 

type Protocol string

Protocol represents a valid rule protocol. 

const (
	// ProtocolAny is to allow any protocol.
	ProtocolAny Protocol = "any"

	// ProtocolICMP is to allow the ICMP protocol.
	ProtocolICMP Protocol = "icmp"

	// ProtocolTCP is to allow the TCP protocol.
	ProtocolTCP Protocol = "tcp"

	// ProtocolUDP is to allow the UDP protocol.
	ProtocolUDP Protocol = "udp"
)

type Rule 

type Rule struct {
	ID                   string `json:"id"`
	Name                 string `json:"name,omitempty"`
	Description          string `json:"description,omitempty"`
	Protocol             string `json:"protocol"`
	Action               string `json:"action"`
	IPVersion            int    `json:"ip_version,omitempty"`
	SourceIPAddress      string `json:"source_ip_address,omitempty"`
	DestinationIPAddress string `json:"destination_ip_address,omitempty"`
	SourcePort           string `json:"source_port,omitempty"`
	DestinationPort      string `json:"destination_port,omitempty"`
	Shared               bool   `json:"shared,omitempty"`
	Enabled              bool   `json:"enabled,omitempty"`
	PolicyID             string `json:"firewall_policy_id"`
	Position             int    `json:"position"`
	TenantID             string `json:"tenant_id"`
	ProjectID            string `json:"project_id"`
}

Rule represents a firewall rule.

func ExtractRules 

func ExtractRules(r pagination.Page) ([]Rule, error)

ExtractRules accepts a Page struct, specifically a RulePage struct, and extracts the elements into a slice of Rule structs. In other words, a generic collection is mapped into a relevant slice.

type RulePage 

type RulePage struct {
	pagination.LinkedPageBase
}

RulePage is the page returned by a pager when traversing over a collection of firewall rules.

func (RulePage) IsEmpty 

func (r RulePage) IsEmpty() (bool, error)

IsEmpty checks whether a RulePage struct is empty.

func (RulePage) NextPageURL 

func (r RulePage) NextPageURL() (string, error)

NextPageURL is invoked when a paginated collection of firewall rules 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 {
	Protocol             *string                `json:"protocol,omitempty"`
	Action               *string                `json:"action,omitempty"`
	Name                 *string                `json:"name,omitempty"`
	Description          *string                `json:"description,omitempty"`
	IPVersion            *gophercloud.IPVersion `json:"ip_version,omitempty"`
	SourceIPAddress      *string                `json:"source_ip_address,omitempty"`
	DestinationIPAddress *string                `json:"destination_ip_address,omitempty"`
	SourcePort           *string                `json:"source_port,omitempty"`
	DestinationPort      *string                `json:"destination_port,omitempty"`
	Shared               *bool                  `json:"shared,omitempty"`
	Enabled              *bool                  `json:"enabled,omitempty"`
}

UpdateOpts contains the values used when updating a firewall rule. These fields are all pointers so that unset fields will not cause the existing Rule attribute to be removed.

func (UpdateOpts) ToRuleUpdateMap 

func (opts UpdateOpts) ToRuleUpdateMap() (map[string]interface{}, error)

ToRuleUpdateMap casts a UpdateOpts struct to a map.

type UpdateOptsBuilder 

type UpdateOptsBuilder interface {
	ToRuleUpdateMap() (map[string]interface{}, error)
}

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 Rule.

func Update 

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

Update allows firewall policies to be updated.

func (UpdateResult) Extract 

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

Extract is a function that accepts a result and extracts a firewall rule.

Source Files

View all Source files

Directories

Path Synopsis
rules unit tests
 rules unit tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.