policies

Documentation

Index

• func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
• type CreateOpts
  • func (opts CreateOpts) ToFirewallPolicyCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResult
  • func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*Policy, error)
• type DeleteResult
  • func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult)
• type GetResult
  • func Get(c *gophercloud.ServiceClient, id string) (r GetResult)
  • func (r GetResult) Extract() (*Policy, error)
• type InsertRuleOpts
  • func (opts InsertRuleOpts) ToFirewallPolicyInsertRuleMap() (map[string]interface{}, error)
• type InsertRuleOptsBuilder
• type InsertRuleResult
  • func InsertRule(c *gophercloud.ServiceClient, id string, opts InsertRuleOptsBuilder) (r InsertRuleResult)
  • func (r InsertRuleResult) Extract() (*Policy, error)
• type ListOpts
  • func (opts ListOpts) ToPolicyListQuery() (string, error)
• type ListOptsBuilder
• type Policy
  • func ExtractPolicies(r pagination.Page) ([]Policy, error)
• type PolicyPage
  • func (r PolicyPage) IsEmpty() (bool, error)
  • func (r PolicyPage) NextPageURL() (string, error)
• type RemoveRuleResult
  • func RemoveRule(c *gophercloud.ServiceClient, id, ruleID string) (r RemoveRuleResult)
  • func (r RemoveRuleResult) Extract() (*Policy, error)
• type UpdateOpts
  • func (opts UpdateOpts) ToFirewallPolicyUpdateMap() (map[string]interface{}, error)
• type UpdateOptsBuilder
• type UpdateResult
  • func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)
  • func (r UpdateResult) Extract() (*Policy, 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 policies. 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 policies that are owned by the tenant who submits the request, unless an admin user submits the request.

Types

type CreateOpts

type CreateOpts struct {
	// Only required if the caller has an admin role and wants to create a firewall policy
	// for another tenant.
	TenantID      string   `json:"tenant_id,omitempty"`
	ProjectID     string   `json:"project_id,omitempty"`
	Name          string   `json:"name,omitempty"`
	Description   string   `json:"description,omitempty"`
	Shared        *bool    `json:"shared,omitempty"`
	Audited       *bool    `json:"audited,omitempty"`
	FirewallRules []string `json:"firewall_rules,omitempty"`
}

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

func (CreateOpts) ToFirewallPolicyCreateMap

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

ToFirewallPolicyCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToFirewallPolicyCreateMap() (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 policy

func (CreateResult) Extract

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

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

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 policy 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) (r GetResult)

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

func (GetResult) Extract

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

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

type InsertRuleOpts

type InsertRuleOpts struct {
	ID           string `json:"firewall_rule_id" required:"true"`
	InsertBefore string `json:"insert_before,omitempty" xor:"InsertAfter"`
	InsertAfter  string `json:"insert_after,omitempty" xor:"InsertBefore"`
}

func (InsertRuleOpts) ToFirewallPolicyInsertRuleMap

func (opts InsertRuleOpts) ToFirewallPolicyInsertRuleMap() (map[string]interface{}, error)

type InsertRuleOptsBuilder

type InsertRuleOptsBuilder interface {
	ToFirewallPolicyInsertRuleMap() (map[string]interface{}, error)
}

type InsertRuleResult

type InsertRuleResult struct {
	// contains filtered or unexported fields
}

InsertRuleResult represents the result of an InsertRule operation.

func InsertRule

func InsertRule(c *gophercloud.ServiceClient, id string, opts InsertRuleOptsBuilder) (r InsertRuleResult)

func (InsertRuleResult) Extract

func (r InsertRuleResult) Extract() (*Policy, error)

Extract is a function that accepts a shortResult and extracts a firewall policy.

type ListOpts

type ListOpts struct {
	TenantID    string `q:"tenant_id"`
	ProjectID   string `q:"project_id"`
	Name        string `q:"name"`
	Description string `q:"description"`
	Shared      *bool  `q:"shared"`
	Audited     *bool  `q:"audited"`
	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 policy attributes you want to see returned. SortKey allows you to sort by a particular firewall policy attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

func (ListOpts) ToPolicyListQuery

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

ToPolicyListQuery formats a ListOpts into a query string.

type ListOptsBuilder

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

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

type Policy

type Policy struct {
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	Description string   `json:"description"`
	TenantID    string   `json:"tenant_id"`
	ProjectID   string   `json:"project_id"`
	Audited     bool     `json:"audited"`
	Shared      bool     `json:"shared"`
	Rules       []string `json:"firewall_rules,omitempty"`
}

Policy is a firewall policy.

func ExtractPolicies

func ExtractPolicies(r pagination.Page) ([]Policy, error)

ExtractPolicies accepts a Page struct, specifically a PolicyPage struct, and extracts the elements into a slice of Policy structs. In other words, a generic collection is mapped into a relevant slice.

type PolicyPage

type PolicyPage struct {
	pagination.LinkedPageBase
}

PolicyPage is the page returned by a pager when traversing over a collection of firewall policies.

func (PolicyPage) IsEmpty

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

IsEmpty checks whether a PolicyPage struct is empty.

func (PolicyPage) NextPageURL

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

NextPageURL is invoked when a paginated collection of firewall policies 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 RemoveRuleResult

type RemoveRuleResult struct {
	// contains filtered or unexported fields
}

RemoveRuleResult represents the result of a RemoveRule operation.

func RemoveRule

func RemoveRule(c *gophercloud.ServiceClient, id, ruleID string) (r RemoveRuleResult)

func (RemoveRuleResult) Extract

func (r RemoveRuleResult) Extract() (*Policy, error)

Extract is a function that accepts a shortResult and extracts a firewall policy.

type UpdateOpts

type UpdateOpts struct {
	Name          *string   `json:"name,omitempty"`
	Description   *string   `json:"description,omitempty"`
	Shared        *bool     `json:"shared,omitempty"`
	Audited       *bool     `json:"audited,omitempty"`
	FirewallRules *[]string `json:"firewall_rules,omitempty"`
}

UpdateOpts contains the values used when updating a firewall policy.

func (UpdateOpts) ToFirewallPolicyUpdateMap

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

ToFirewallPolicyUpdateMap casts a CreateOpts struct to a map.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToFirewallPolicyUpdateMap() (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() (*Policy, error)

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