rules

Documentation

Index

• func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
• type Acl
• type Action
• type Address
• type CreateFirewallRuleResponse
• type CreateOptsBuilder
• type CreateResult
  • func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
  • func OutboundCreate(c *gophercloud.ServiceClient, opts OutboundCreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*Rule, error)
  • func (r CreateResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)
• type DeleteResult
  • func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult)
• type FirewallRules
• type GetResult
  • func Get(c *gophercloud.ServiceClient, id string) (r GetResult)
  • func (r GetResult) Extract() (*Rule, error)
  • func (r GetResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)
• type InboundCreateOpts
  • func (opts InboundCreateOpts) ToRuleCreateMap() (map[string]interface{}, error)
• type ListOpts
  • func (opts ListOpts) ToRuleListQuery() (string, error)
• type ListOptsBuilder
• type NetworkInterface
• type OutboundCreateOpts
  • func (opts OutboundCreateOpts) ToOutboundRuleCreateMap() (map[string]interface{}, error)
• type OutboundCreateOptsBuilder
• type Protocol
• type Rule
  • func ExtractRules(r pagination.Page) ([]Rule, error)
• type RulePage
  • func (r RulePage) IsEmpty() (bool, error)
  • func (r RulePage) NextPageURL() (string, error)
• type Service
• type UpdateOpts
  • func (opts UpdateOpts) ToRuleUpdateMap() (map[string]interface{}, error)
• type UpdateOptsBuilder
• type UpdateResult
  • func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)
  • func (r UpdateResult) Extract() (*Rule, error)
  • func (r UpdateResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)

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 Acl

type Acl struct {
	SrcIntfs []NetworkInterface `json:"srcintfs"`
	Schedule string             `json:"schedule"`
	Comments string             `json:"comments"`
	NatIP    string             `json:"natip"`
	DstAddrs []Address          `json:"dstaddrs"`
	Name     string             `json:"name"`
	DstIntfs []NetworkInterface `json:"dstintfs"`
	Action   string             `json:"action"`
	ID       int                `json:"id"`
	Services []Service          `json:"services"`
	SrcAddrs []Address          `json:"srcaddrs"`
	Status   string             `json:"status"`
}

type Action

type Action string

Action represents a valid rule protocol

const (
	// ActionAllow is to allow traffic
	ActionAllow Action = "allow"

	// ActionDeny is to deny traffic
	ActionDeny Action = "deny"

	// ActionTCP is to reject traffic
	ActionReject Action = "reject"
)

type Address

type Address struct {
	IP string `json:"ip"`
}

type CreateFirewallRuleResponse

type CreateFirewallRuleResponse struct {
	JopID string `json:"job_id"`
}

type CreateOptsBuilder

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

CreateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Create operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

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 CreateOptsBuilder) (r CreateResult)

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

func OutboundCreate

func OutboundCreate(c *gophercloud.ServiceClient, opts OutboundCreateOptsBuilder) (r CreateResult)

func (CreateResult) Extract

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

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

func (CreateResult) ExtractJobInfo

func (r CreateResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)

type DeleteResult

type DeleteResult struct {
	gophercloud.ErrResult
}

DeleteResult represents the result of a delete operation.

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 FirewallRules

type FirewallRules struct {
	Rules []Rule `json:"firewallrules"`
}

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) (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.

func (GetResult) ExtractJobInfo

func (r GetResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)

type InboundCreateOpts

type InboundCreateOpts struct {
	SourceNetID   string   `json:"srcnetworkid" required:"true"`
	PortFordingID string   `json:"virtualipid" required:"true"`
	DestIPAdds    string   `json:"dstip" required:"true"`
	StartPort     string   `json:"startport,omitempty"`
	EndPort       string   `json:"endport,omitempty"`
	Protocol      Protocol `json:"protocol" required:"true"`
	DestNetID     string   `json:"dstnetworkid" required:"true"`
	Action        Action   `json:"action" required:"true"`
}

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

func (InboundCreateOpts) ToRuleCreateMap

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

ToRuleCreateMap casts a CreateOpts struct to a map.

type ListOpts

type ListOpts struct {
	TenantID             string   `q:"tenant_id"`
	Name                 string   `q:"name"`
	Description          string   `q:"description"`
	Protocol             Protocol `q:"protocol"`
	Action               Action   `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"`
	Shared               *bool    `q:"shared"`
	ProjectID            string   `q:"project_id"`
	FirewallPolicyID     string   `q:"firewall_policy_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 NetworkInterface

type NetworkInterface struct {
	NetworkName string `json:"networkname"`
	NetworkID   string `json:"networkid"`
	Interface   string `json:"interface"`
}

type OutboundCreateOpts

type OutboundCreateOpts struct {
	SourceNetID  string   `json:"srcnetworkid" required:"true"` // Network(Tier) ID
	SourceIPAdds string   `json:"srcip" required:"true"`        // Original network (~/24) or VM Private IP (~/32)
	StartPort    string   `json:"startport,omitempty"`
	EndPort      string   `json:"endport,omitempty"`
	Protocol     Protocol `json:"protocol" required:"true"`     // TCP, UDP, ICMP, or ALL
	DestNetID    string   `json:"dstnetworkid" required:"true"` // Network(Tier) ID. Ex) External Network ID
	DestIPAdds   string   `json:"dstip" required:"true"`        // Ex) "0.0.0.0/0"
	SourceNAT    string   `json:"srcnat" required:"true"`       // Set as 'true' when setting an outbound firewall
	Action       Action   `json:"action" required:"true"`
}

OutboundCreateOpts contains all the values needed to create a new 'outbound' firewall rule.

func (OutboundCreateOpts) ToOutboundRuleCreateMap

func (opts OutboundCreateOpts) ToOutboundRuleCreateMap() (map[string]interface{}, error)

type OutboundCreateOptsBuilder

type OutboundCreateOptsBuilder interface {
	ToOutboundRuleCreateMap() (map[string]interface{}, error)
}

type Protocol

type Protocol string

Protocol represents a valid rule protocol

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

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

	// ProtocolUDP is to allow the UDP protocol
	ProtocolUDP Protocol = "UDP"

	// ProtocolICMP is to allow the ICMP protocol
	ProtocolICMP Protocol = "ICMP"
)

type Rule

type Rule struct {
	Acls  []Acl  `json:"acls"`
	VpcID string `json:"vpcid"`
}

func ExtractRules

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

ExtractRules 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 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 Service

type Service struct {
	StartPort string `json:"startport"`
	Protocol  string `json:"protocol"`
	EndPort   string `json:"endport"`
}

type UpdateOpts

type UpdateOpts struct {
	Protocol             *Protocol              `json:"protocol,omitempty"`
	Action               *Action                `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.

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 is the interface options structs have to satisfy in order to be used in the main Update operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

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

func (UpdateResult) ExtractJobInfo

func (r UpdateResult) ExtractJobInfo() (*CreateFirewallRuleResponse, error)