controllers

Documentation

Index

• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Create(ctx context.Context, req *CreateRequest) (*CreateResponse, error)
  • func (c *Client) Delete(ctx context.Context, req *DeleteRequest) (*DeleteResponse, error)
  • func (c *Client) Find(ctx context.Context, req *FindRequest) (*FindResponse, error)
  • func (c *Client) Index(ctx context.Context, req *IndexRequest) (*IndexResponse, error)
  • func (c *Client) Update(ctx context.Context, req *UpdateRequest) (*UpdateResponse, error)
• type CreateRequest
• type CreateResponse
• type DeleteRequest
• type DeleteResponse
• type FindRequest
• type FindResponse
• type HTTPClient
• type IndexRequest
• type IndexResponse
• type UpdateRequest
• type UpdateResponse

Types

type Client

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

func New

func New(c HTTPClient) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, req *CreateRequest) (*CreateResponse, error)

Create Create a new sdn controller object.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, req *DeleteRequest) (*DeleteResponse, error)

Delete Delete sdn controller object configuration.

func (*Client) Find

func (c *Client) Find(ctx context.Context, req *FindRequest) (*FindResponse, error)

Find Read sdn controller configuration.

func (*Client) Index

func (c *Client) Index(ctx context.Context, req *IndexRequest) (*IndexResponse, error)

Index SDN controllers index.

func (*Client) Update

func (c *Client) Update(ctx context.Context, req *UpdateRequest) (*UpdateResponse, error)

Update Update sdn controller object configuration.

type CreateRequest

type CreateRequest struct {
	Controller string `url:"controller",json:"controller"` // The SDN controller object identifier.
	Type       string `url:"type",json:"type"`             // Plugin type.

	// The following parameters are optional
	Asn                     *int    `url:"asn,omitempty",json:"asn,omitempty"` // autonomous system number
	BgpMultipathAsPathRelax *bool   `url:"bgp-multipath-as-path-relax,omitempty",json:"bgp-multipath-as-path-relax,omitempty"`
	Ebgp                    *bool   `url:"ebgp,omitempty",json:"ebgp,omitempty"` // Enable ebgp. (remote-as external)
	EbgpMultihop            *int    `url:"ebgp-multihop,omitempty",json:"ebgp-multihop,omitempty"`
	Loopback                *string `url:"loopback,omitempty",json:"loopback,omitempty"` // source loopback interface.
	Node                    *string `url:"node,omitempty",json:"node,omitempty"`         // The cluster node name.
	Peers                   *string `url:"peers,omitempty",json:"peers,omitempty"`       // peers address list.
}

type CreateResponse

type CreateResponse map[string]interface{}

type DeleteRequest

type DeleteRequest struct {
	Controller string `url:"controller",json:"controller"` // The SDN controller object identifier.

}

type DeleteResponse

type DeleteResponse map[string]interface{}

type FindRequest

type FindRequest struct {
	Controller string `url:"controller",json:"controller"` // The SDN controller object identifier.

	// The following parameters are optional
	Pending *bool `url:"pending,omitempty",json:"pending,omitempty"` // Display pending config.
	Running *bool `url:"running,omitempty",json:"running,omitempty"` // Display running config.
}

type FindResponse

type FindResponse map[string]interface{}

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexRequest

type IndexRequest map[string]interface{}

type IndexResponse

type IndexResponse []*struct {
	Controller string `url:"controller",json:"controller"`
	Type       string `url:"type",json:"type"`

	// The following parameters are optional
	State *string `url:"state,omitempty",json:"state,omitempty"`
}

type UpdateRequest

type UpdateRequest struct {
	Controller string `url:"controller",json:"controller"` // The SDN controller object identifier.

	// The following parameters are optional
	Asn                     *int    `url:"asn,omitempty",json:"asn,omitempty"` // autonomous system number
	BgpMultipathAsPathRelax *bool   `url:"bgp-multipath-as-path-relax,omitempty",json:"bgp-multipath-as-path-relax,omitempty"`
	Delete                  *string `url:"delete,omitempty",json:"delete,omitempty"` // A list of settings you want to delete.
	Digest                  *string `url:"digest,omitempty",json:"digest,omitempty"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	Ebgp                    *bool   `url:"ebgp,omitempty",json:"ebgp,omitempty"`     // Enable ebgp. (remote-as external)
	EbgpMultihop            *int    `url:"ebgp-multihop,omitempty",json:"ebgp-multihop,omitempty"`
	Loopback                *string `url:"loopback,omitempty",json:"loopback,omitempty"` // source loopback interface.
	Node                    *string `url:"node,omitempty",json:"node,omitempty"`         // The cluster node name.
	Peers                   *string `url:"peers,omitempty",json:"peers,omitempty"`       // peers address list.
}

type UpdateResponse

type UpdateResponse map[string]interface{}