edgegw

Documentation

Index

• Variables
• type BaseEdgeGW
  • func (e BaseEdgeGW) GetID() string
  • func (e BaseEdgeGW) GetIDOrName() string
  • func (e BaseEdgeGW) GetName() string
• type EdgeGateway
  • func (e EdgeGateway) GetID() string
  • func (e EdgeGateway) GetName() string
  • func (e EdgeGateway) GetParent() (client.VDCOrVDCGroupHandler, error)
  • func (e EdgeGateway) Lock(ctx context.Context)
  • func (e EdgeGateway) Unlock(ctx context.Context)
• type Handler

Variables

var ErrEdgeGatewayIDOrNameIsEmpty = fmt.Errorf("edge gateway ID or name is empty")

Types

type BaseEdgeGW

type BaseEdgeGW struct {
	ID   types.String
	Name types.String
}

func (BaseEdgeGW) GetID

func (e BaseEdgeGW) GetID() string

GetID returns the ID of the Edge Gateway.

func (BaseEdgeGW) GetIDOrName

func (e BaseEdgeGW) GetIDOrName() string

GetIDOrName returns the ID or the name of the Edge Gateway.

func (BaseEdgeGW) GetName

func (e BaseEdgeGW) GetName() string

GetName returns the Edge Gateway Name.

type EdgeGateway

type EdgeGateway struct {
	Client *client.CloudAvenue
	*govcd.NsxtEdgeGateway
}

func (EdgeGateway) GetID

func (e EdgeGateway) GetID() string

GetID returns the ID of the Edge Gateway.

func (EdgeGateway) GetName

func (e EdgeGateway) GetName() string

GetName returns the name of the Edge Gateway.

func (EdgeGateway) GetParent

func (e EdgeGateway) GetParent() (client.VDCOrVDCGroupHandler, error)

GetParent returns the parent of the Edge Gateway. The parent is VDC Or VDC Group object.

func (EdgeGateway) Lock

func (e EdgeGateway) Lock(ctx context.Context)

Lock locks the Edge Gateway.

func (EdgeGateway) Unlock

func (e EdgeGateway) Unlock(ctx context.Context)

Unlock unlocks the Edge Gateway.

type Handler

type Handler interface {
	// GetEdgeGateway allows retrieving NSX-T edge gateway by ID Or Name.
	GetEdgeGateway(egw BaseEdgeGW) (EdgeGateway, error)
}