subnets

package
v1.0.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateURL 

func CreateURL(c *gophercloud.ServiceClient) string

func DeleteURL 

func DeleteURL(c *gophercloud.ServiceClient, vpcId string, subnetId string) string

func GetURL 

func GetURL(c *gophercloud.ServiceClient, subnetId string) string

func List 

func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager

List returns a Pager which allows you to iterate over a collection of subnets. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those subnets that are owned by the tenant who submits the request, unless the request is submitted by a user with administrative rights.

func UpdateURL 

func UpdateURL(c *gophercloud.ServiceClient, vpcId string, subnetId string) string

Types

type CreateOpts 

type CreateOpts struct {
	// Specifies the subnet name. The value is a string of 1 to 64
	// characters that can contain letters, digits, underscores (_), and hyphens (-).
	Name string `json:"name" required:"true"`

	// Specifies the subnet description. The value is a string of 0 to 255
	// characters and cannot contain "<" or ">".
	Description string `json:"description,omitempty"`

	// Specifies the network segment on which the subnet resides. The
	// value must be in CIDR format. The value must be within the CIDR block of the VPC. The
	// subnet mask cannot be greater than 28.
	Cidr string `json:"cidr" required:"true"`

	// Specifies the gateway of the subnet. The value must be a valid
	// IP address. The value must be an IP address in the subnet segment.
	GatewayIP string `json:"gateway_ip" required:"true"`

	// Specifies whether the DHCP function is enabled for the subnet.
	// The value can be true or false. If this parameter is left blank, it is set to true by
	// default.
	DhcpEnable *bool `json:"dhcp_enable,omitempty"`

	// Specifies the IP address of DNS server 1 on the subnet. The
	// value must be a valid IP address.
	PrimaryDNS string `json:"primary_dns,omitempty"`

	// Specifies the IP address of DNS server 2 on the subnet. The
	// value must be a valid IP address.
	SecondaryDNS string `json:"secondary_dns,omitempty"`

	// Specifies the DNS server address list of a subnet. This field
	// is required if you need to use more than two DNS servers. This parameter value is the
	// superset of both DNS server address 1 and DNS server address 2.
	DNSList []string `json:"dnsList,omitempty"`

	// Identifies the availability zone (AZ) to which the subnet
	// belongs. The value must be an existing AZ in the system.
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// Specifies the ID of the VPC to which the subnet belongs.
	VpcID string `json:"vpc_id" required:"true"`
}

func (CreateOpts) ToCreateMap 

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

type CreateOptsBuilder 

type CreateOptsBuilder interface {
	ToCreateMap() (map[string]interface{}, error)
}

type CreateResult 

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

func Create 

func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

func (CreateResult) Extract 

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

type DeleteResult 

type DeleteResult struct {
	gophercloud.ErrResult
}

func Delete 

func Delete(client *gophercloud.ServiceClient, vpcId string, subnetId string) (r DeleteResult)

type GetResult 

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

func Get 

func Get(client *gophercloud.ServiceClient, subnetId string) (r GetResult)

func (GetResult) Extract 

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

type ListOpts 

type ListOpts struct {
	//Specifies that the VPC ID is used as the filtering condition.
	VpcID string `q:"vpc_id"`

	//Specifies the number of records returned on each page.
	//The value ranges from 0 to intmax.
	Limit int `q:"limit"`

	//Specifies the resource ID of pagination query.
	//If the parameter is left blank, only resources on the first page are queried.
	Marker string `q:"marker"`
}

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 subnet attributes you want to see returned.

func (ListOpts) ToSubnetListQuery 

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

ToSubnetListQuery formats a ListOpts into a query string.

type ListOptsBuilder 

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

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

type Subnet 

type Subnet struct {
	// Specifies a resource ID in UUID format.
	ID string `json:"id"`

	// Specifies the subnet name. The value is a string of 1 to 64
	// characters that can contain letters, digits, underscores (_), and hyphens (-).
	Name string `json:"name"`

	// Specifies the subnet description. The value is a string of 0 to 255
	// characters and cannot contain "<" or ">".
	Description string `json:"description,omitempty"`

	// Specifies the network segment on which the subnet resides. The
	// value must be in CIDR format. The value must be within the CIDR block of the VPC. The
	// subnet mask cannot be greater than 28.
	Cidr string `json:"cidr"`

	// Specifies the gateway of the subnet. The value must be a valid
	// IP address. The value must be an IP address in the subnet segment.
	GatewayIP string `json:"gateway_ip"`

	// Specifies whether the DHCP function is enabled for the subnet.
	// The value can be true or false. If this parameter is left blank, it is set to true by
	// default.
	DhcpEnable bool `json:"dhcp_enable,omitempty"`

	// Specifies the IP address of DNS server 1 on the subnet. The
	// value must be a valid IP address.
	PrimaryDNS string `json:"primary_dns,omitempty"`

	// Specifies the IP address of DNS server 2 on the subnet. The
	// value must be a valid IP address.
	SecondaryDNS string `json:"secondary_dns,omitempty"`

	// Specifies the DNS server address list of a subnet. This field
	// is required if you need to use more than two DNS servers. This parameter value is the
	// superset of both DNS server address 1 and DNS server address 2.
	DNSList []string `json:"dnsList,omitempty"`

	// Identifies the availability zone (AZ) to which the subnet
	// belongs. The value must be an existing AZ in the system.
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// Specifies the ID of the VPC to which the subnet belongs.
	VpcID string `json:"vpc_id"`

	// Specifies the status of the subnet. The value can be ACTIVE,
	// DOWN, UNKNOWN, or ERROR.
	Status string `json:"status"`

	// Specifies the network (Native OpenStack API) ID.
	NeutronNetworkID string `json:"neutron_network_id"`

	// Specifies the subnet (Native OpenStack API) ID.
	NeutronSubnetID string `json:"neutron_subnet_id"`
}

Subnet represents a subnet. See package documentation for a top-level description of what this is.

func ExtractSubnets 

func ExtractSubnets(r pagination.Page) ([]Subnet, error)

ExtractSubnets accepts a Page struct, specifically a SubnetPage struct, and extracts the elements into a slice of Subnet structs. In other words, a generic collection is mapped into a relevant slice.

type SubnetPage 

type SubnetPage struct {
	pagination.LinkedPageBase
}

SubnetPage is the page returned by a pager when traversing over a collection of subnets.

func (SubnetPage) IsEmpty 

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

IsEmpty checks whether a SubnetPage struct is empty.

func (SubnetPage) NextPageURL 

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

NextPageURL is invoked when a paginated collection of subnets 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 {
	// Specifies the subnet name. The value is a string of 1 to 64
	// characters that can contain letters, digits, underscores (_), and hyphens (-).
	Name string `json:"name" required:"true"`

	// Specifies the subnet description. The value is a string of 0 to 255
	// characters and cannot contain "<" or ">".
	Description string `json:"description,omitempty"`

	// Specifies whether the DHCP function is enabled for the subnet.
	// The value can be true or false. If this parameter is left blank, it is set to true by
	// default.
	DhcpEnable *bool `json:"dhcp_enable,omitempty"`

	// Specifies the IP address of DNS server 1 on the subnet. The
	// value must be a valid IP address.
	PrimaryDNS string `json:"primary_dns,omitempty"`

	// Specifies the IP address of DNS server 2 on the subnet. The
	// value must be a valid IP address.
	SecondaryDNS string `json:"secondary_dns,omitempty"`

	// Specifies the DNS server address list of a subnet. This field
	// is required if you need to use more than two DNS servers. This parameter value is the
	// superset of both DNS server address 1 and DNS server address 2.
	DNSList []string `json:"dnsList,omitempty"`
}

func (UpdateOpts) ToUpdateMap 

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

type UpdateOptsBuilder 

type UpdateOptsBuilder interface {
	ToUpdateMap() (map[string]interface{}, error)
}

type UpdateResp 

type UpdateResp struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}

type UpdateResult 

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

func Update 

func Update(client *gophercloud.ServiceClient, vpcId string, subnetId string, opts UpdateOptsBuilder) (r UpdateResult)

func (UpdateResult) Extract 

func (r UpdateResult) Extract() (*UpdateResp, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.