policies

Documentation

Overview

Package policies allows management and retrieval of Firewall Policies in the OpenStack Networking Service.

Example to List Policies

listOpts := policies.ListOpts{
	TenantID: "966b3c7d36a24facaf20b7e458bf2192",
}

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

allPolicies, err := policies.ExtractPolicies(allPages)
if err != nil {
	panic(err)
}

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

Example to Create a Policy

createOpts := policies.CreateOpts{
	Name:        "policy_1",
	Description: "A policy",
	Rules: []string{
		"98a58c87-76be-ae7c-a74e-b77fffb88d95",
		"7c4f087a-ed46-4ea8-8040-11ca460a61c0",
	}
}

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

Example to Update a Policy

policyID := "38aee955-6283-4279-b091-8b9c828000ec"

updateOpts := policies.UpdateOpts{
	Description: "New Description",
}

policy, err := policies.Update(networkClient, policyID, updateOpts).Extract()
if err != nil {
	panic(err)
}

Example to Delete a Policy

policyID := "38aee955-6283-4279-b091-8b9c828000ec"
err := policies.Delete(networkClient, policyID).ExtractErr()
if err != nil {
	panic(err)
}

Example to Add a Rule to a Policy

policyID := "38aee955-6283-4279-b091-8b9c828000ec"
ruleOpts := policies.InsertRuleOpts{
	ID: "98a58c87-76be-ae7c-a74e-b77fffb88d95",
}

policy, err := policies.AddRule(networkClient, policyID, ruleOpts).Extract()
if err != nil {
	panic(err)
}

Example to Delete a Rule from a Policy

policyID := "38aee955-6283-4279-b091-8b9c828000ec"
ruleID := "98a58c87-76be-ae7c-a74e-b77fffb88d95",

policy, err := policies.RemoveRule(networkClient, policyID, ruleID).Extract()
if err != nil {
	panic(err)
}

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 AddRule(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 {
	// TenantID specifies a tenant to own the firewall. The caller must have
	// an admin role in order to set this. Otherwise, this field is left unset
	// and the caller will be the owner.
	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"`
	Rules       []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 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 Policy.

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. Call its ExtractErr method to determine if the operation succeeded or failed.

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. Call its Extract method to interpret it as a Policy.

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"`
	BeforeRuleID string `json:"insert_before,omitempty"`
	AfterRuleID  string `json:"insert_after,omitempty"`
}

InsertRuleOpts contains the values used when updating a policy's rules.

func (InsertRuleOpts) ToFirewallPolicyInsertRuleMap

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

type InsertRuleOptsBuilder

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

InsertRuleOptsBuilder allows extensions to add additional parameters to the InsertRule request.

type InsertRuleResult

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

InsertRuleResult represents the result of an InsertRule operation. Call its Extract method to interpret it as a Policy.

func AddRule

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

AddRule will add a rule to a policy.

func (InsertRuleResult) Extract

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

Extract is a function that accepts a result 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 Policy 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. Call its Extract method to interpret it as a Policy.

func RemoveRule

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

RemoveRule will add a rule to a policy.

func (RemoveRuleResult) Extract

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

Extract is a function that accepts a result 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"`
	Rules       []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 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 Policy.

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.