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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
package subnetpools
import (
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/pagination"
)
// ListOptsBuilder allows extensions to add additional parameters to the
// List request.
type ListOptsBuilder interface {
ToSubnetPoolListQuery() (string, error)
}
// ListOpts allows the filtering and sorting of paginated collections through
// the Neutron API. Filtering is achieved by passing in struct field values
// that map to the subnetpool attributes you want to see returned.
// SortKey allows you to sort by a particular subnetpool attribute.
// SortDir sets the direction, and is either `asc' or `desc'.
// Marker and Limit are used for the pagination.
type ListOpts struct {
ID string `q:"id"`
Name string `q:"name"`
DefaultQuota int `q:"default_quota"`
TenantID string `q:"tenant_id"`
ProjectID string `q:"project_id"`
DefaultPrefixLen int `q:"default_prefixlen"`
MinPrefixLen int `q:"min_prefixlen"`
MaxPrefixLen int `q:"max_prefixlen"`
AddressScopeID string `q:"address_scope_id"`
IPVersion int `q:"ip_version"`
Shared *bool `q:"shared"`
Description string `q:"description"`
IsDefault *bool `q:"is_default"`
RevisionNumber int `q:"revision_number"`
Limit int `q:"limit"`
Marker string `q:"marker"`
SortKey string `q:"sort_key"`
SortDir string `q:"sort_dir"`
}
// ToSubnetPoolListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToSubnetPoolListQuery() (string, error) {
q, err := gophercloud.BuildQueryString(opts)
return q.String(), err
}
// List returns a Pager which allows you to iterate over a collection of
// subnetpools. It accepts a ListOpts struct, which allows you to filter and sort
// the returned collection for greater efficiency.
//
// Default policy settings return only the subnetpools owned by the project
// of the user submitting the request, unless the user has the administrative role.
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
url := listURL(c)
if opts != nil {
query, err := opts.ToSubnetPoolListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(c, url, func(r pagination.PageResult) pagination.Page {
return SubnetPoolPage{pagination.LinkedPageBase{PageResult: r}}
})
}
// Get retrieves a specific subnetpool based on its ID.
func Get(c *gophercloud.ServiceClient, id string) (r GetResult) {
_, r.Err = c.Get(getURL(c, id), &r.Body, nil)
return
}
// CreateOptsBuilder allows to add additional parameters to the
// Create request.
type CreateOptsBuilder interface {
ToSubnetPoolCreateMap() (map[string]interface{}, error)
}
// CreateOpts specifies parameters of a new subnetpool.
type CreateOpts struct {
// Name is the human-readable name of the subnetpool.
Name string `json:"name"`
// DefaultQuota is the per-project quota on the prefix space
// that can be allocated from the subnetpool for project subnets.
DefaultQuota int `json:"default_quota,omitempty"`
// TenantID is the id of the Identity project.
TenantID string `json:"tenant_id,omitempty"`
// ProjectID is the id of the Identity project.
ProjectID string `json:"project_id,omitempty"`
// Prefixes is the list of subnet prefixes to assign to the subnetpool.
// Neutron API merges adjacent prefixes and treats them as a single prefix.
// Each subnet prefix must be unique among all subnet prefixes in all subnetpools
// that are associated with the address scope.
Prefixes []string `json:"prefixes"`
// DefaultPrefixLen is the size of the prefix to allocate when the cidr
// or prefixlen attributes are omitted when you create the subnet.
// Defaults to the MinPrefixLen.
DefaultPrefixLen int `json:"default_prefixlen,omitempty"`
// MinPrefixLen is the smallest prefix that can be allocated from a subnetpool.
// For IPv4 subnetpools, default is 8.
// For IPv6 subnetpools, default is 64.
MinPrefixLen int `json:"min_prefixlen,omitempty"`
// MaxPrefixLen is the maximum prefix size that can be allocated from the subnetpool.
// For IPv4 subnetpools, default is 32.
// For IPv6 subnetpools, default is 128.
MaxPrefixLen int `json:"max_prefixlen,omitempty"`
// AddressScopeID is the Neutron address scope to assign to the subnetpool.
AddressScopeID string `json:"address_scope_id,omitempty"`
// Shared indicates whether this network is shared across all projects.
Shared bool `json:"shared,omitempty"`
// Description is the human-readable description for the resource.
Description string `json:"description,omitempty"`
// IsDefault indicates if the subnetpool is default pool or not.
IsDefault bool `json:"is_default,omitempty"`
}
// ToSubnetPoolCreateMap constructs a request body from CreateOpts.
func (opts CreateOpts) ToSubnetPoolCreateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "subnetpool")
}
// Create requests the creation of a new subnetpool on the server.
func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
b, err := opts.ToSubnetPoolCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = client.Post(createURL(client), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{201},
})
return
}
// UpdateOptsBuilder allows extensions to add additional parameters to the
// Update request.
type UpdateOptsBuilder interface {
ToSubnetPoolUpdateMap() (map[string]interface{}, error)
}
// UpdateOpts represents options used to update a network.
type UpdateOpts struct {
// Name is the human-readable name of the subnetpool.
Name string `json:"name,omitempty"`
// DefaultQuota is the per-project quota on the prefix space
// that can be allocated from the subnetpool for project subnets.
DefaultQuota *int `json:"default_quota,omitempty"`
// TenantID is the id of the Identity project.
TenantID string `json:"tenant_id,omitempty"`
// ProjectID is the id of the Identity project.
ProjectID string `json:"project_id,omitempty"`
// Prefixes is the list of subnet prefixes to assign to the subnetpool.
// Neutron API merges adjacent prefixes and treats them as a single prefix.
// Each subnet prefix must be unique among all subnet prefixes in all subnetpools
// that are associated with the address scope.
Prefixes []string `json:"prefixes,omitempty"`
// DefaultPrefixLen is yhe size of the prefix to allocate when the cidr
// or prefixlen attributes are omitted when you create the subnet.
// Defaults to the MinPrefixLen.
DefaultPrefixLen int `json:"default_prefixlen,omitempty"`
// MinPrefixLen is the smallest prefix that can be allocated from a subnetpool.
// For IPv4 subnetpools, default is 8.
// For IPv6 subnetpools, default is 64.
MinPrefixLen int `json:"min_prefixlen,omitempty"`
// MaxPrefixLen is the maximum prefix size that can be allocated from the subnetpool.
// For IPv4 subnetpools, default is 32.
// For IPv6 subnetpools, default is 128.
MaxPrefixLen int `json:"max_prefixlen,omitempty"`
// AddressScopeID is the Neutron address scope to assign to the subnetpool.
AddressScopeID *string `json:"address_scope_id,omitempty"`
// Description is thehuman-readable description for the resource.
Description *string `json:"description,omitempty"`
// IsDefault indicates if the subnetpool is default pool or not.
IsDefault *bool `json:"is_default,omitempty"`
}
// ToSubnetPoolUpdateMap builds a request body from UpdateOpts.
func (opts UpdateOpts) ToSubnetPoolUpdateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "subnetpool")
}
// Update accepts a UpdateOpts struct and updates an existing subnetpool using the
// values provided.
func Update(c *gophercloud.ServiceClient, subnetPoolID string, opts UpdateOptsBuilder) (r UpdateResult) {
b, err := opts.ToSubnetPoolUpdateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = c.Put(updateURL(c, subnetPoolID), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
// Delete accepts a unique ID and deletes the subnetpool associated with it.
func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult) {
_, r.Err = c.Delete(deleteURL(c, id), nil)
return
}
|