1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
package groups
import (
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/pagination"
)
// ListOptsBuilder allows extensions to add additional parameters to the
// List request.
type ListOptsBuilder interface {
ToGroupListQuery() (string, error)
}
// 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 group attributes you want to see returned. SortKey allows you
// to sort by a particular firewall group attribute. SortDir sets the direction,
// and is either `asc' or `desc'. Marker and Limit are used for pagination.
type ListOpts struct {
TenantID string `q:"tenant_id"`
Name string `q:"name"`
Description string `q:"description"`
IngressFirewallPolicyID string `q:"ingress_firewall_policy_id"`
EgressFirewallPolicyID string `q:"egress_firewall_policy_id"`
AdminStateUp *bool `q:"admin_state_up"`
Ports *[]string `q:"ports"`
Status string `q:"status"`
ID string `q:"id"`
Shared *bool `q:"shared"`
ProjectID string `q:"project_id"`
Limit int `q:"limit"`
Marker string `q:"marker"`
SortKey string `q:"sort_key"`
SortDir string `q:"sort_dir"`
}
// ToGroupListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToGroupListQuery() (string, error) {
q, err := gophercloud.BuildQueryString(opts)
if err != nil {
return "", err
}
return q.String(), err
}
// List returns a Pager which allows you to iterate over a collection of
// firewall groups. It accepts a ListOpts struct, which allows you to filter
// and sort the returned collection for greater efficiency.
//
// Default group settings return only those firewall groups that are owned by the
// tenant who submits the request, unless an admin user submits the request.
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
url := rootURL(c)
if opts != nil {
query, err := opts.ToGroupListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(c, url, func(r pagination.PageResult) pagination.Page {
return GroupPage{pagination.LinkedPageBase{PageResult: r}}
})
}
// Get retrieves a particular firewall group based on its unique ID.
func Get(c *gophercloud.ServiceClient, id string) (r GetResult) {
_, r.Err = c.Get(resourceURL(c, id), &r.Body, nil)
return
}
// 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 CreateOptsBuilder interface {
ToFirewallGroupCreateMap() (map[string]interface{}, error)
}
// CreateOpts contains all the values needed to create a new firewall group.
type CreateOpts struct {
ID string `json:"id,omitempty"`
TenantID string `json:"tenant_id,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
IngressFirewallPolicyID string `json:"ingress_firewall_policy_id,omitempty"`
EgressFirewallPolicyID string `json:"egress_firewall_policy_id,omitempty"`
AdminStateUp *bool `json:"admin_state_up,omitempty"`
Ports []string `json:"ports,omitempty"`
Shared *bool `json:"shared,omitempty"`
ProjectID string `json:"project_id,omitempty"`
}
// ToFirewallGroupCreateMap casts a CreateOpts struct to a map.
func (opts CreateOpts) ToFirewallGroupCreateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "firewall_group")
}
// Create accepts a CreateOpts struct and uses the values to create a new firewall group
func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
b, err := opts.ToFirewallGroupCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = c.Post(rootURL(c), b, &r.Body, nil)
return
}
// 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 UpdateOptsBuilder interface {
ToFirewallGroupUpdateMap() (map[string]interface{}, error)
}
// UpdateOpts contains the values used when updating a firewall group.
type UpdateOpts struct {
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
IngressFirewallPolicyID *string `json:"ingress_firewall_policy_id,omitempty"`
EgressFirewallPolicyID *string `json:"egress_firewall_policy_id,omitempty"`
AdminStateUp *bool `json:"admin_state_up,omitempty"`
Ports *[]string `json:"ports,omitempty"`
Shared *bool `json:"shared,omitempty"`
}
// ToFirewallGroupUpdateMap casts a UpdateOpts struct to a map.
func (opts UpdateOpts) ToFirewallGroupUpdateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "firewall_group")
}
// Update allows firewall groups to be updated.
func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult) {
b, err := opts.ToFirewallGroupUpdateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = c.Put(resourceURL(c, id), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
// Because of fwaas_v2 wait only UUID not string and base updateOpts has omitempty,
// only set nil allows firewall group policies to be unset.
// Two different functions, because can not specify both policy in one function.
// New functions needs new structs without omitempty.
// Separate function for BuildRequestBody is missing due to complication
// of code readability and bulkiness.
type RemoveIngressPolicyOpts struct {
IngressFirewallPolicyID *string `json:"ingress_firewall_policy_id"`
}
func RemoveIngressPolicy(c *gophercloud.ServiceClient, id string) (r UpdateResult) {
b, err := gophercloud.BuildRequestBody(RemoveIngressPolicyOpts{IngressFirewallPolicyID: nil}, "firewall_group")
if err != nil {
r.Err = err
return
}
_, r.Err = c.Put(resourceURL(c, id), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
type RemoveEgressPolicyOpts struct {
EgressFirewallPolicyID *string `json:"egress_firewall_policy_id"`
}
func RemoveEgressPolicy(c *gophercloud.ServiceClient, id string) (r UpdateResult) {
b, err := gophercloud.BuildRequestBody(RemoveEgressPolicyOpts{EgressFirewallPolicyID: nil}, "firewall_group")
if err != nil {
r.Err = err
return
}
_, r.Err = c.Put(resourceURL(c, id), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
// Delete will permanently delete a particular firewall group based on its unique ID.
func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult) {
_, r.Err = c.Delete(resourceURL(c, id), nil)
return
}
|
