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) GetIPSetByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)
  • func (e EdgeGateway) GetIPSetByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)
  • func (e EdgeGateway) GetIPSetByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
  • func (e EdgeGateway) GetName() string
  • func (e EdgeGateway) GetParent() (sdkv1.VDCOrVDCGroupInterface, error)
  • func (e EdgeGateway) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
  • func (e EdgeGateway) Lock(ctx context.Context)
  • func (e EdgeGateway) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)
  • 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

	// EdgeClient is the EdgeGateway client.
	*sdkv1.EdgeClient

	// NsxtEdgeGateway is the NSX-T edge gateway.
	//
	// Deprecated: Use EdgeClient instead.
	*govcd.NsxtEdgeGateway
}

func (EdgeGateway) GetID

func (e EdgeGateway) GetID() string

GetID returns the ID of the Edge Gateway.

func (EdgeGateway) GetIPSetByID

func (e EdgeGateway) GetIPSetByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)

GetIPSetByID.

func (EdgeGateway) GetIPSetByName

func (e EdgeGateway) GetIPSetByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)

GetIPSetByName.

func (EdgeGateway) GetIPSetByNameOrID

func (e EdgeGateway) GetIPSetByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)

GetIPSetByNameOrID.

func (EdgeGateway) GetName

func (e EdgeGateway) GetName() string

GetName returns the name of the Edge Gateway.

func (EdgeGateway) GetParent

func (e EdgeGateway) GetParent() (sdkv1.VDCOrVDCGroupInterface, error)

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

func (EdgeGateway) GetSecurityGroupByNameOrID

func (e EdgeGateway) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)

GetSecurityGroupByNameOrID.

func (EdgeGateway) Lock

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

Lock locks the Edge Gateway.

func (EdgeGateway) SetIPSet

func (e EdgeGateway) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)

SetIPSet.

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)
}