Documentation ¶
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 Binary ¶
type Binary *bool
Binary gives users a solid type to work with for create and update operations. It is recommended that users use the `Yes` and `No` enums
type CreateOpts ¶
type CreateOpts struct { // Mandatory for create Protocol string Action string // Optional TenantID string Name string Description string IPVersion int SourceIPAddress string DestinationIPAddress string SourcePort string DestinationPort string Enabled *bool }
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 ¶
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) 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.
func Delete ¶
func Delete(c *gophercloud.ServiceClient, id string) 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.
func Get ¶
func Get(c *gophercloud.ServiceClient, id string) GetResult
Get retrieves a particular firewall rule based on its unique ID.
type ListOpts ¶
type ListOpts struct { TenantID string `q:"tenant_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 ¶
ToRuleListQuery formats a ListOpts into a query string.
type ListOptsBuilder ¶
ListOptsBuilder allows extensions to add additional parameters to the List request.
type Rule ¶
type Rule struct { ID string `json:"id" mapstructure:"id"` Name string `json:"name,omitempty" mapstructure:"name"` Description string `json:"description,omitempty" mapstructure:"description"` Protocol string `json:"protocol" mapstructure:"protocol"` Action string `json:"action" mapstructure:"action"` IPVersion int `json:"ip_version,omitempty" mapstructure:"ip_version"` SourceIPAddress string `json:"source_ip_address,omitempty" mapstructure:"source_ip_address"` DestinationIPAddress string `json:"destination_ip_address,omitempty" mapstructure:"destination_ip_address"` SourcePort string `json:"source_port,omitempty" mapstructure:"source_port"` DestinationPort string `json:"destination_port,omitempty" mapstructure:"destination_port"` Enabled bool `json:"enabled,omitempty" mapstructure:"enabled"` PolicyID string `json:"firewall_policy_id" mapstructure:"firewall_policy_id"` Position int `json:"position" mapstructure:"position"` TenantID string `json:"tenant_id" mapstructure:"tenant_id"` }
Rule represents a firewall rule
func ExtractRules ¶
func ExtractRules(page 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 string Action string Name string Description string IPVersion int SourceIPAddress *string DestinationIPAddress *string SourcePort *string DestinationPort *string Enabled *bool }
UpdateOpts contains the values used when updating a firewall rule. Optional
func (UpdateOpts) ToRuleUpdateMap ¶
func (opts UpdateOpts) ToRuleUpdateMap() (map[string]interface{}, 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(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) UpdateResult
Update allows firewall policies to be updated.