portsbinding

Documentation

Overview

Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.

Index

• type CreateOptsExt
  • func (opts CreateOptsExt) ToPortCreateMap() (map[string]interface{}, error)
• type IP
• type PortsBindingExt
• type UpdateOptsExt
  • func (opts UpdateOptsExt) ToPortUpdateMap() (map[string]interface{}, error)

Types

type CreateOptsExt

type CreateOptsExt struct {
	// CreateOptsBuilder is the interface options structs have to satisfy in order
	// to be used in the main Create operation in this package.
	ports.CreateOptsBuilder

	// The ID of the host where the port is allocated
	HostID string `json:"binding:host_id,omitempty"`

	// The virtual network interface card (vNIC) type that is bound to the
	// neutron port.
	VNICType string `json:"binding:vnic_type,omitempty"`

	// A dictionary that enables the application running on the specified
	// host to pass and receive virtual network interface (VIF) port-specific
	// information to the plug-in.
	Profile map[string]string `json:"binding:profile,omitempty"`
}

CreateOptsExt adds port binding options to the base ports.CreateOpts.

func (CreateOptsExt) ToPortCreateMap

func (opts CreateOptsExt) ToPortCreateMap() (map[string]interface{}, error)

ToPortCreateMap casts a CreateOpts struct to a map.

type IP

type IP struct {
	SubnetID  string `json:"subnet_id"`
	IPAddress string `json:"ip_address"`
}

IP is a sub-struct that represents an individual IP.

type PortsBindingExt

type PortsBindingExt struct {
	// The ID of the host where the port is allocated.
	HostID string `json:"binding:host_id"`

	// A dictionary that enables the application to pass information about
	// functions that the Networking API provides.
	VIFDetails map[string]interface{} `json:"binding:vif_details"`

	// The VIF type for the port.
	VIFType string `json:"binding:vif_type"`

	// The virtual network interface card (vNIC) type that is bound to the
	// neutron port.
	VNICType string `json:"binding:vnic_type"`

	// A dictionary that enables the application running on the specified
	// host to pass and receive virtual network interface (VIF) port-specific
	// information to the plug-in.
	Profile map[string]string `json:"binding:profile"`
}

PortsBindingExt represents a decorated form of a Port with the additional port binding information.

type UpdateOptsExt

type UpdateOptsExt struct {
	// UpdateOptsBuilder is the interface options structs have to satisfy in order
	// to be used in the main Update operation in this package.
	ports.UpdateOptsBuilder

	// The ID of the host where the port is allocated.
	HostID string `json:"binding:host_id,omitempty"`

	// The virtual network interface card (vNIC) type that is bound to the
	// neutron port.
	VNICType string `json:"binding:vnic_type,omitempty"`

	// A dictionary that enables the application running on the specified
	// host to pass and receive virtual network interface (VIF) port-specific
	// information to the plug-in.
	Profile map[string]string `json:"binding:profile,omitempty"`
}

UpdateOptsExt adds port binding options to the base ports.UpdateOpts

func (UpdateOptsExt) ToPortUpdateMap

func (opts UpdateOptsExt) ToPortUpdateMap() (map[string]interface{}, error)

ToPortUpdateMap casts an UpdateOpts struct to a map.