Documentation ¶
Index ¶
- func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
- type Action
- type CreateOpts
- type CreateOptsBuilder
- type CreateResult
- type DeleteResult
- type GetResult
- type ListOpts
- type ListOptsBuilder
- type Protocol
- type Rule
- type RulePage
- type UpdateOpts
- type UpdateOptsBuilder
- type UpdateResult
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 Action `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"` 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]any, error)
ToRuleCreateMap casts a CreateOpts struct to a map.
type CreateOptsBuilder ¶
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(ctx context.Context, c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
Create accepts a CreateOpts struct and uses the values to create a new firewall rule
type DeleteResult ¶
type DeleteResult struct {
gophercloud.ErrResult
}
DeleteResult represents the result of a delete operation.
type GetResult ¶
type GetResult struct {
// contains filtered or unexported fields
}
GetResult represents the result of a get operation.
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"` 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 ¶
ToRuleListQuery formats a ListOpts into a query string.
type ListOptsBuilder ¶
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"` Enabled bool `json:"enabled,omitempty"` FirewallPolicyID []string `json:"firewall_policy_id"` 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 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) NextPageURL ¶
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 *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"` Enabled *bool `json:"enabled,omitempty"` }
UpdateOpts contains the values used when updating a firewall rule.
func (UpdateOpts) ToRuleUpdateMap ¶
func (opts UpdateOpts) ToRuleUpdateMap() (map[string]any, error)
ToRuleUpdateMap casts a UpdateOpts struct to a map.
type UpdateOptsBuilder ¶
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(ctx context.Context, c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)
Update allows firewall policies to be updated.