provider

type ACLProvider interface {
	Provider

	// EnsureACL call is responsible for AccessControlList realization on the provider.
	EnsureACL(context.Context, *EnsureACLRequest) error
	// DeleteACL call is responsible for AccessControlList deletion on the provider.
	DeleteACL(context.Context, *DeleteACLRequest) error
}

type BGPPeerProvider interface {
	Provider

	// EnsureBGPPeer call is responsible for BGPPeer realization on the provider.
	EnsureBGPPeer(context.Context, *EnsureBGPPeerRequest) error
	// DeleteBGPPeer call is responsible for BGPPeer deletion on the provider.
	DeleteBGPPeer(context.Context, *DeleteBGPPeerRequest) error
	// GetPeerStatus call is responsible for retrieving the current status of the BGPPeer from the provider.
	GetPeerStatus(context.Context, *BGPPeerStatusRequest) (BGPPeerStatus, error)
}

type BGPPeerStatus struct {
	SessionState        v1alpha1.BGPPeerSessionState
	LastEstablishedTime time.Time
	AddressFamilies     map[v1alpha1.BGPAddressFamilyType]*PrefixStats
}

type BGPPeerStatusRequest struct {
	BGPPeer        *v1alpha1.BGPPeer
	ProviderConfig *ProviderConfig
}

type BGPProvider interface {
	Provider

	// EnsureBGP call is responsible for BGP realization on the provider.
	EnsureBGP(context.Context, *EnsureBGPRequest) error
	// DeleteBGP call is responsible for BGP deletion on the provider.
	DeleteBGP(context.Context, *DeleteBGPRequest) error
}

type BannerProvider interface {
	Provider

	// EnsureBanner call is responsible for Banner realization on the provider.
	EnsureBanner(context.Context, *EnsureBannerRequest) error
	// DeleteBanner call is responsible for Banner deletion on the provider.
	DeleteBanner(context.Context, *DeleteBannerRequest) error
}

type CertificateProvider interface {
	Provider

	// EnsureCertificate call is responsible for Certificate realization on the provider.
	EnsureCertificate(context.Context, *EnsureCertificateRequest) error
	// DeleteCertificate call is responsible for Certificate deletion on the provider.
	DeleteCertificate(context.Context, *DeleteCertificateRequest) error
}

type DNSProvider interface {
	Provider

	// EnsureDNS call is responsible for DNS realization on the provider.
	EnsureDNS(context.Context, *EnsureDNSRequest) error
	// DeleteDNS call is responsible for DNS deletion on the provider.
	DeleteDNS(context.Context) error
}

type DeleteACLRequest struct {
	Name           string
	ProviderConfig *ProviderConfig
}

type DeleteBGPPeerRequest struct {
	BGPPeer        *v1alpha1.BGPPeer
	ProviderConfig *ProviderConfig
}

type DeleteBGPRequest struct {
	BGP            *v1alpha1.BGP
	ProviderConfig *ProviderConfig
}

type DeleteBannerRequest struct {
	Type v1alpha1.BannerType
}

type DeleteCertificateRequest struct {
	ID             string
	ProviderConfig *ProviderConfig
}

type DeleteISISRequest struct {
	ISIS           *v1alpha1.ISIS
	ProviderConfig *ProviderConfig
}

type DeleteOSPFRequest struct {
	OSPF           *v1alpha1.OSPF
	ProviderConfig *ProviderConfig
}

type DeletePIMRequest struct {
	PIM            *v1alpha1.PIM
	ProviderConfig *ProviderConfig
}

type DeleteRoutingPolicyRequest struct {
	Name string
}

type DeleteSNMPRequest struct {
	ProviderConfig *ProviderConfig
}

type DeleteUserRequest struct {
	Username       string
	ProviderConfig *ProviderConfig
}

type DeviceInfo struct {
	// Manufacturer is the manufacturer of the device, e.g. "Cisco".
	Manufacturer string
	// Model is the model of the device, e.g. "N9K-C9332D-GX2B".
	Model string
	// SerialNumber is the serial number of the device.
	SerialNumber string
	// FirmwareVersion is the firmware version running on the device, e.g. "10.4(3)".
	FirmwareVersion string
}

type DevicePort struct {
	// ID is the unique identifier of the port on the device.
	ID string
	// Type is the type of the port, e.g. "10g".
	Type string
	// SupportedSpeedsGbps is the list of supported speeds for the port in Gbps.
	SupportedSpeedsGbps []int32
	// Trasceiver is the type of transceiver present on the port, e.g. "SFP" or "QSFP", if any.
	Transceiver string
}

type DeviceProvider interface {
	Provider

	// ListPorts retrieves the list of available ports on the device.
	// This can be used to validate port references in other resources.
	ListPorts(context.Context) ([]DevicePort, error)
	// GetDeviceInfo retrieves basic information about the device,
	// such as manufacturer, model, serial number, and firmware version.
	GetDeviceInfo(context.Context) (*DeviceInfo, error)
	// Reboot initiates a reboot of the device.
	Reboot(context.Context, *deviceutil.Connection) error
	// FactoryReset performs a factory reset of the device.
	FactoryReset(context.Context, *deviceutil.Connection) error
	// Reprovision prepares the device for reprovisioning by resetting it and reenabling provisioning mechanisms.
	Reprovision(context.Context, *deviceutil.Connection) error
}

type EVPNInstanceProvider interface {
	Provider

	// EnsureEVPNInstance call is responsible for EVPNInstance realization on the provider.
	EnsureEVPNInstance(context.Context, *EVPNInstanceRequest) error
	// DeleteEVPNInstance call is responsible for EVPNInstance deletion on the provider.
	DeleteEVPNInstance(context.Context, *EVPNInstanceRequest) error
}

type EVPNInstanceRequest struct {
	EVPNInstance   *v1alpha1.EVPNInstance
	ProviderConfig *ProviderConfig
	VLAN           *v1alpha1.VLAN
}

type EnsureACLRequest struct {
	ACL            *v1alpha1.AccessControlList
	ProviderConfig *ProviderConfig
}

type EnsureBGPPeerRequest struct {
	BGPPeer         *v1alpha1.BGPPeer
	ProviderConfig  *ProviderConfig
	SourceInterface string
}

type EnsureBGPRequest struct {
	BGP            *v1alpha1.BGP
	ProviderConfig *ProviderConfig
}

type EnsureBannerRequest struct {
	Message        string
	Type           v1alpha1.BannerType
	ProviderConfig *ProviderConfig
}

type EnsureCertificateRequest struct {
	ID             string
	Certificate    *tls.Certificate
	ProviderConfig *ProviderConfig
}

type EnsureDNSRequest struct {
	DNS            *v1alpha1.DNS
	ProviderConfig *ProviderConfig
}

type EnsureISISRequest struct {
	ISIS           *v1alpha1.ISIS
	Interfaces     []*v1alpha1.Interface
	ProviderConfig *ProviderConfig
}

type EnsureInterfaceRequest struct {
	Interface      *v1alpha1.Interface
	ProviderConfig *ProviderConfig
	IPv4           IPv4

	// Members is the list of member interfaces for aggregated interfaces.
	// This field is only applicable if the interface type is Aggregate.
	Members []*v1alpha1.Interface
	// MultiChassisID is the multi-chassis identifier for multi-chassis link aggregation.
	MultiChassisID *int16
	// VLAN is the referenced VLAN for routed VLAN interfaces (SVI).
	// This field is only applicable if the interface type is RoutedVLAN.
	VLAN *v1alpha1.VLAN
	// VRF is the VRF to which the interface belongs.
	// If unset, the interface is part of the default VRF.
	// Only applicable for layer3 interfaces.
	VRF *v1alpha1.VRF
}

type EnsureManagementAccessRequest struct {
	ManagementAccess *v1alpha1.ManagementAccess
	ProviderConfig   *ProviderConfig
}

type EnsureNTPRequest struct {
	NTP            *v1alpha1.NTP
	ProviderConfig *ProviderConfig
}

type EnsureOSPFRequest struct {
	OSPF           *v1alpha1.OSPF
	ProviderConfig *ProviderConfig
	Interfaces     []OSPFInterface
}

type EnsurePIMRequest struct {
	PIM            *v1alpha1.PIM
	Interfaces     []PIMInterface
	ProviderConfig *ProviderConfig
}

type EnsureRoutingPolicyRequest struct {
	Name           string
	Statements     []PolicyStatement
	ProviderConfig *ProviderConfig
}

type EnsureSNMPRequest struct {
	SNMP           *v1alpha1.SNMP
	ProviderConfig *ProviderConfig
}

type EnsureSyslogRequest struct {
	Syslog         *v1alpha1.Syslog
	ProviderConfig *ProviderConfig
}

type EnsureUserRequest struct {
	Username       string
	Password       string // #nosec G117
	SSHKey         string
	Roles          []string
	ProviderConfig *ProviderConfig
}

type IPv4 interface {
	// contains filtered or unexported methods
}

type IPv4AddressList []netip.Prefix

type IPv4Unnumbered struct {
	SourceInterface string
}

type ISISProvider interface {
	Provider

	// EnsureISIS call is responsible for ISIS realization on the provider.
	EnsureISIS(context.Context, *EnsureISISRequest) error
	// DeleteISIS call is responsible for ISIS deletion on the provider.
	DeleteISIS(context.Context, *DeleteISISRequest) error
}

type InterfaceProvider interface {
	Provider

	// EnsureInterface call is responsible for Interface realization on the provider.
	EnsureInterface(context.Context, *EnsureInterfaceRequest) error
	// DeleteInterface call is responsible for Interface deletion on the provider.
	DeleteInterface(context.Context, *InterfaceRequest) error
	// GetInterfaceStatus call is responsible for retrieving the current status of the Interface from the provider.
	GetInterfaceStatus(context.Context, *InterfaceRequest) (InterfaceStatus, error)
}

type InterfaceRequest struct {
	Interface      *v1alpha1.Interface
	ProviderConfig *ProviderConfig
}

type InterfaceStatus struct {
	// OperStatus indicates whether the interface is operationally up (true) or down (false).
	OperStatus bool
	// OperMessage provides additional information about the operational status of the interface.
	OperMessage string
}

type ManagementAccessProvider interface {
	Provider

	// EnsureManagementAccess call is responsible for ManagementAccess realization on the provider.
	EnsureManagementAccess(context.Context, *EnsureManagementAccessRequest) error
	// DeleteManagementAccess call is responsible for ManagementAccess deletion on the provider.
	DeleteManagementAccess(context.Context) error
}

type MatchPrefixSetCondition struct {
	PrefixSet *v1alpha1.PrefixSet
}

type NTPProvider interface {
	Provider

	// EnsureNTP call is responsible for NTP realization on the provider.
	EnsureNTP(context.Context, *EnsureNTPRequest) error
	// DeleteNTP call is responsible for NTP deletion on the provider.
	DeleteNTP(context.Context) error
}

type NVEProvider interface {
	Provider

	// EnsureVRF call is responsible for VRF realization on the provider.
	EnsureNVE(context.Context, *NVERequest) error
	// DeleteVRF call is responsible for VRF deletion on the provider.
	DeleteNVE(context.Context, *NVERequest) error
	// GetInterfaceStatus call is responsible for retrieving the current status of the Interface from the provider.
	GetNVEStatus(context.Context, *NVERequest) (NVEStatus, error)
}

type NVERequest struct {
	NVE                    *v1alpha1.NetworkVirtualizationEdge
	SourceInterface        *v1alpha1.Interface
	AnycastSourceInterface *v1alpha1.Interface
	ProviderConfig         *ProviderConfig
}

type NVEStatus struct {
	// OperStatus indicates whether the NVE is operationally up (true) or down (false).
	OperStatus bool
	// OperStatusSourceInterface indicates if the primary source interface is operationally up (true) or down (false).
	OperStatusSourceInterface bool
	// OperStatusAnycastSourceInterface indicates if the primary and anycast interfaces are operationally up (true) or down (false).
	OperStatusAnycastSourceInterface bool
	// SourceInterfaceName is the name of the interface configured as source interface in the remote device.
	SourceInterfaceName string
	// AnycastSourceInterfaceName is the name of the interface configured as anycast source interface in the remote device.
	AnycastSourceInterfaceName string
	// HostReachabilityType is the type of host reachability configured on the remote device.
	HostReachabilityType string
}

type OSPFInterface struct {
	Interface *v1alpha1.Interface
	Area      string
	Passive   *bool
}

type OSPFNeighbor struct {
	RouterID            string
	Address             string
	Interface           *v1alpha1.Interface
	Priority            uint8
	LastEstablishedTime time.Time
	AdjacencyState      v1alpha1.OSPFNeighborState
}

type OSPFProvider interface {
	Provider

	// EnsureOSPF call is responsible for OSPF realization on the provider.
	EnsureOSPF(context.Context, *EnsureOSPFRequest) error
	// DeleteOSPF call is responsible for OSPF deletion on the provider.
	DeleteOSPF(context.Context, *DeleteOSPFRequest) error
	// GetOSPFStatus call is responsible for retrieving the current status of the OSPF from the provider.
	GetOSPFStatus(context.Context, *OSPFStatusRequest) (OSPFStatus, error)
}

type OSPFStatus struct {
	// OperStatus indicates whether the ospf instance is operationally up (true) or down (false).
	OperStatus bool
	// Neighbors is a list of OSPF neighbors and their adjacency states.
	Neighbors []OSPFNeighbor
}

type OSPFStatusRequest struct {
	OSPF           *v1alpha1.OSPF
	ProviderConfig *ProviderConfig
	Interfaces     []OSPFInterface
}

type PIMInterface struct {
	Interface *v1alpha1.Interface
	Mode      v1alpha1.PIMInterfaceMode
}

type PIMProvider interface {
	Provider

	// EnsurePIM call is responsible for PIM realization on the provider.
	EnsurePIM(context.Context, *EnsurePIMRequest) error
	// DeletePIM call is responsible for PIM deletion on the provider.
	DeletePIM(context.Context, *DeletePIMRequest) error
}

type PolicyCondition interface {
	// contains filtered or unexported methods
}

type PolicyStatement struct {
	Sequence   int32
	Conditions []PolicyCondition
	Actions    v1alpha1.PolicyActions
}

type PrefixSetProvider interface {
	Provider

	// EnsurePrefixSet call is responsible for PrefixSet realization on the provider.
	EnsurePrefixSet(context.Context, *PrefixSetRequest) error
	// DeletePrefixSet call is responsible for PrefixSet deletion on the provider.
	DeletePrefixSet(context.Context, *PrefixSetRequest) error
}

type PrefixSetRequest struct {
	PrefixSet      *v1alpha1.PrefixSet
	ProviderConfig *ProviderConfig
}

type PrefixStats struct {
	Accepted   uint32
	Advertised uint32
}

type Provider interface {
	Connect(context.Context, *deviceutil.Connection) error
	Disconnect(context.Context, *deviceutil.Connection) error
}

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

type ProviderFunc func() Provider

type ProvisioningProvider interface {
	// HashedPassword takes a plaintext password and returns the hashed password along with the hash type. This is necessary to securely provision user accounts on devices using a potentially insecure channel.
	HashProvisioningPassword(password string) (string, string, error)
	// VerifyProvisioned checks if the provisioning process has been completed successfully on the device.
	VerifyProvisioned(context.Context, *deviceutil.Connection, *v1alpha1.Device) bool
}

type RoutingPolicyProvider interface {
	Provider

	// EnsureRoutingPolicy call is responsible for RoutingPolicy realization on the provider.
	EnsureRoutingPolicy(context.Context, *EnsureRoutingPolicyRequest) error
	// DeleteRoutingPolicy call is responsible for RoutingPolicy deletion on the provider.
	DeleteRoutingPolicy(context.Context, *DeleteRoutingPolicyRequest) error
}

type SNMPProvider interface {
	Provider

	// EnsureSNMP call is responsible for SNMP realization on the provider.
	EnsureSNMP(context.Context, *EnsureSNMPRequest) error
	// DeleteSNMP call is responsible for SNMP deletion on the provider.
	DeleteSNMP(context.Context, *DeleteSNMPRequest) error
}

type SyslogProvider interface {
	Provider

	// EnsureSyslog call is responsible for Syslog realization on the provider.
	EnsureSyslog(context.Context, *EnsureSyslogRequest) error
	// DeleteSyslog call is responsible for Syslog deletion on the provider.
	DeleteSyslog(context.Context) error
}

type UserProvider interface {
	Provider

	// EnsureUser call is responsible for User realization on the provider.
	EnsureUser(context.Context, *EnsureUserRequest) error
	// DeleteUser call is responsible for User deletion on the provider.
	DeleteUser(context.Context, *DeleteUserRequest) error
}

type VLANProvider interface {
	Provider

	// EnsureVLAN call is responsible for VLAN realization on the provider.
	EnsureVLAN(context.Context, *VLANRequest) error
	// DeleteVLAN call is responsible for VLAN deletion on the provider.
	DeleteVLAN(context.Context, *VLANRequest) error
	// GetVLANStatus call is responsible for retrieving the current status of the VLAN from the provider.
	GetVLANStatus(context.Context, *VLANRequest) (VLANStatus, error)
}

type VLANRequest struct {
	VLAN           *v1alpha1.VLAN
	ProviderConfig *ProviderConfig
}

type VLANStatus struct {
	// OperStatus indicates whether the interface is operationally up (true) or down (false).
	OperStatus bool
}

type VRFProvider interface {
	Provider

	// EnsureVRF call is responsible for VRF realization on the provider.
	EnsureVRF(context.Context, *VRFRequest) error
	// DeleteVRF call is responsible for VRF deletion on the provider.
	DeleteVRF(context.Context, *VRFRequest) error
}

type VRFRequest struct {
	VRF            *v1alpha1.VRF
	ProviderConfig *ProviderConfig
}