state

package

v1.1.0 Latest Latest Go to latest Published: Oct 6, 2023 License: BSD-3-Clause Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rtbrick/go-rbfs-client

Links

Open Source Insights

Documentation ¶

Overview ¶

* RBFS Operational State API * * This contract describes the RBFS Operational State API contract defined by RBMS, the RtBrick Management System. This API is a _consumer-driven_ API, which means that all changes to this API **must be approved** by RBMS, the consumer of this API to avoid compatibility issues. The API is kept backwards-compatible and anyone is allowed to _use_ this API. The consumer of the API _must_ ignore additional attributes not explained in this specification. Additional attributes are _not_ considered violating backwards compatibility. In contrary, additional attributes allow extending the API while preserving backward compatibility. * * API version: 1.0.0 * Contact: martin@rtbrick.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type A10NSPApiService
- func (a *A10NSPApiService) GetA10NSPL2XEndpoint(ctx context.Context, lagInterfaceName string, sVlan int) ([]A10nspConfig, *http.Response, error)
- func (a *A10NSPApiService) GetA10NSPL2XEndpoints(ctx context.Context) ([]A10nspConfig, *http.Response, error)
- func (a *A10NSPApiService) GetA10NSPL2XEndpointsOfLAGInterface(ctx context.Context, lagInterfaceName string) ([]A10nspConfig, *http.Response, error)
- func (a *A10NSPApiService) ProcessA10NSPL2XBatch(ctx context.Context, body A10nspConfigBatch) (*http.Response, error)
- func (a *A10NSPApiService) RemoveA10NSPL2XEndpoint(ctx context.Context, lagInterfaceName string, sVlan int) (*http.Response, error)
- func (a *A10NSPApiService) StoreA10NSPL2XEndpoint(ctx context.Context, body A10nspConfig, lagInterfaceName string, sVlan int) (*http.Response, error)
- func (a *A10NSPApiService) StoreA10NSPL2XEndpoints(ctx context.Context, body []A10nspConfig) (*http.Response, error)
- func (a *A10NSPApiService) StoreA10NSPL2XEndpointsForLAGInterface(ctx context.Context, body []A10nspConfig, lagInterfaceName string) (*http.Response, error)
type A10nspConfig
type A10nspConfigBatch
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AccessApiAddVLANProfileOpts
type AccessApiDeleteVLANProfileOpts
type AccessApiFlushVLANProfilesOpts
type AccessApiGetVLANProfilesOpts
type AccessApiService
- func (a *AccessApiService) AddVLANProfile(ctx context.Context, body VlanProfile, ifpName string, ...) (*http.Response, error)
- func (a *AccessApiService) DeleteVLANProfile(ctx context.Context, ifpName string, ...) (*http.Response, error)
- func (a *AccessApiService) FlushVLANProfiles(ctx context.Context, localVarOptionals *AccessApiFlushVLANProfilesOpts) (*http.Response, error)
- func (a *AccessApiService) GetVLANProfiles(ctx context.Context, localVarOptionals *AccessApiGetVLANProfilesOpts) ([]VlanProfile, *http.Response, error)
- func (a *AccessApiService) ProcessVLANProfilesBatch(ctx context.Context, body VlanProfileBatch) (*http.Response, error)
- func (a *AccessApiService) StoreVLANProfiles(ctx context.Context, body []VlanProfile, ...) (*http.Response, error)
type AccessApiStoreVLANProfilesOpts
type AccessLineInfo
type AccessLineInfoDataLink
type AccessLineInfoDownstream
type AccessLineInfoUpstream
type ActionsApiPingOpts
type ActionsApiService
- func (a *ActionsApiService) Ping(ctx context.Context, localVarOptionals *ActionsApiPingOpts) (PingStatus, *http.Response, error)
- func (a *ActionsApiService) Traceroute(ctx context.Context, localVarOptionals *ActionsApiTracerouteOpts) (Traceroute, *http.Response, error)
type ActionsApiTracerouteOpts
type AllOfIsisInstanceInterfacesSegmentRouting
type AllOfIsisInstanceSegmentRouting
type AllOfIsisInterfaceSegmentRouting
type BGPApiService
- func (a *BGPApiService) ClearBGPInstancePeerings(ctx context.Context, instanceName string) (*http.Response, error)
- func (a *BGPApiService) ClearBGPPeering(ctx context.Context, instanceName string, peerIp string) (*http.Response, error)
- func (a *BGPApiService) GetBGPInstance(ctx context.Context, instanceName string) (BgpInstance, *http.Response, error)
- func (a *BGPApiService) GetBGPInstances(ctx context.Context) ([]BgpInstanceRef, *http.Response, error)
- func (a *BGPApiService) GetBGPPeering(ctx context.Context, instanceName string, peerIp string) (BgpPeering, *http.Response, error)
- func (a *BGPApiService) GetBGPPeerings(ctx context.Context) ([]BgpInstancePeerings, *http.Response, error)
type BasicAuth
type BgpAfiSafiStatistics
type BgpInstance
type BgpInstanceCapabilities
type BgpInstancePeerings
type BgpInstancePeeringsSummary
type BgpInstanceRef
type BgpInstanceRouteSelection
type BgpInstanceTimers
type BgpPeer
type BgpPeering
type BgpPeeringCapabilities
type BgpPeeringRef
type BgpPeeringStatistics
type BgpPeeringTimers
type BgpState
type BgpStatistics
type BgpStatisticsEgress
type BgpStatisticsIngress
type Chassis
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Fan
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type ISISApiService
- func (a *ISISApiService) ClearISISInstanceNeighbors(ctx context.Context, instanceName string) (*http.Response, error)
- func (a *ISISApiService) ClearISISInterfaceNeighbors(ctx context.Context, instanceName string, iflName string) (*http.Response, error)
- func (a *ISISApiService) GetISISInstance(ctx context.Context, instanceName string) (IsisInstance, *http.Response, error)
- func (a *ISISApiService) GetISISInstances(ctx context.Context) ([]IsisInstanceRef, *http.Response, error)
- func (a *ISISApiService) GetISISInterface(ctx context.Context, instanceName string, iflName string) (IsisInstanceInterface, *http.Response, error)
- func (a *ISISApiService) GetISISInterfaces(ctx context.Context) ([]IsisInstanceInterfaces, *http.Response, error)
- func (a *ISISApiService) GetISISNeighbor(ctx context.Context, instanceName string, iflName string) (IsisInstanceNeighbor, *http.Response, error)
- func (a *ISISApiService) GetISISNeighbors(ctx context.Context) ([]IsisInstanceNeighbors, *http.Response, error)
type IfpSubscriberSessionStatistics
type InstanceMulticastRoutes
type InstanceUnicastRoutes
type InterfacesApiGetPhysicalInterfaceOpts
type InterfacesApiGetPhysicalInterfacesOpts
type InterfacesApiService
- func (a *InterfacesApiService) ClearInterfaceCounters(ctx context.Context, ifName string) (*http.Response, error)
- func (a *InterfacesApiService) ClearLogicalInterfaceCounters(ctx context.Context, iflName string) (*http.Response, error)
- func (a *InterfacesApiService) ClearPhysicalInterfaceCounters(ctx context.Context, ifpName string) (*http.Response, error)
- func (a *InterfacesApiService) DisableInterface(ctx context.Context, ifName string) (*http.Response, error)
- func (a *InterfacesApiService) DisableLogicalInterface(ctx context.Context, iflName string) (*http.Response, error)
- func (a *InterfacesApiService) DisablePhysicalInterface(ctx context.Context, ifpName string) (*http.Response, error)
- func (a *InterfacesApiService) EnableInterface(ctx context.Context, ifName string) (*http.Response, error)
- func (a *InterfacesApiService) EnableLogicalInterface(ctx context.Context, iflName string) (*http.Response, error)
- func (a *InterfacesApiService) EnablePhysicalInterface(ctx context.Context, ifpName string) (*http.Response, error)
- func (a *InterfacesApiService) GetInterface(ctx context.Context, ifpName string) (PhysicalInterfaceSummary, *http.Response, error)
- func (a *InterfacesApiService) GetInterfaces(ctx context.Context) ([]PhysicalInterfaceSummaryRef, *http.Response, error)
- func (a *InterfacesApiService) GetLogicalInterface(ctx context.Context, iflName string) (LogicalInterface, *http.Response, error)
- func (a *InterfacesApiService) GetPhysicalInterface(ctx context.Context, ifpName string, ...) (PhysicalInterfaceDetail, *http.Response, error)
- func (a *InterfacesApiService) GetPhysicalInterfaces(ctx context.Context, localVarOptionals *InterfacesApiGetPhysicalInterfacesOpts) ([]PhysicalInterface, *http.Response, error)
- func (a *InterfacesApiService) StartLogicalInterfaceTrafficCapture(ctx context.Context, iflName string, direction string, fileName string) (*http.Response, error)
- func (a *InterfacesApiService) StartPhysicalInterfaceTrafficCapture(ctx context.Context, ifpName string, direction string, fileName string) (*http.Response, error)
- func (a *InterfacesApiService) StartTrafficCapture(ctx context.Context, ifName string, direction string, fileName string) (*http.Response, error)
- func (a *InterfacesApiService) StopLogicalInterfaceTrafficCapture(ctx context.Context, iflName string, direction string, fileName string) (*http.Response, error)
- func (a *InterfacesApiService) StopPhysicalInterfaceTrafficCapture(ctx context.Context, ifpName string, direction string, fileName string) (*http.Response, error)
- func (a *InterfacesApiService) StopTrafficCapture(ctx context.Context, ifName string, direction string, fileName string) (*http.Response, error)
type IsisInstance
type IsisInstanceInterface
type IsisInstanceInterfaces
type IsisInstanceInterfacesInterfaces
type IsisInstanceNeighbor
type IsisInstanceNeighbors
type IsisInstanceNeighborsSummary
type IsisInstanceRef
type IsisInstanceRefInterfaces
type IsisInstanceRefNeighbors
type IsisInstanceTimers
type IsisInterface
type IsisInterfaceLevel
type IsisInterfaceLevelStatistics
type IsisInterfaceLevelStatisticsIngress
type IsisInterfaceSriDs
type IsisNeighbor
type IsisNeighborNeighbor
type IsisNeighborStatistics
type IsisNeighborTimers
type L2BSAApiService
- func (a *L2BSAApiService) GetL2BSAService(ctx context.Context, ifpName string) ([]L2bsaServiceConfig, *http.Response, error)
- func (a *L2BSAApiService) GetL2BSAServices(ctx context.Context) ([]L2bsaServiceConfig, *http.Response, error)
- func (a *L2BSAApiService) GetL2BSAServicesOfANP(ctx context.Context, ifpName string, anp int) (L2bsaServiceConfig, *http.Response, error)
- func (a *L2BSAApiService) ProcessL2BSAServiceBatch(ctx context.Context, body L2bsaServiceConfigBatch) (*http.Response, error)
- func (a *L2BSAApiService) RemoveL2BSAServicesForANP(ctx context.Context, ifpName string, anp int) (*http.Response, error)
- func (a *L2BSAApiService) StoreL2BSAService(ctx context.Context, body []L2bsaServiceConfig, ifpName string) ([]L2bsaServiceConfig, *http.Response, error)
- func (a *L2BSAApiService) StoreL2BSAServices(ctx context.Context, body []L2bsaServiceConfig) ([]L2bsaServiceConfig, *http.Response, error)
- func (a *L2BSAApiService) StoreL2BSAServicesForANP(ctx context.Context, body L2bsaServiceConfig, ifpName string, anp int) (*http.Response, error)
type L2bsaServiceConfig
type L2bsaServiceConfigBatch
type L2bsaServiceConfigQos
type L2xConfig
type LDPApiService
- func (a *LDPApiService) ClearLDPSession(ctx context.Context, instanceName string, peerIp string) (*http.Response, error)
- func (a *LDPApiService) ClearLDPSessions(ctx context.Context, instanceName string) (*http.Response, error)
- func (a *LDPApiService) GetLDPInstance(ctx context.Context, instanceName string) (LdpInstanceSessions, *http.Response, error)
- func (a *LDPApiService) GetLDPInstances(ctx context.Context) (LdpInstanceRef, *http.Response, error)
- func (a *LDPApiService) GetLDPSession(ctx context.Context, instanceName string, peerIp string) (LdpInstanceSession, *http.Response, error)
- func (a *LDPApiService) GetLDPSessions(ctx context.Context) (LdpInstanceSessions, *http.Response, error)
type LLDPApiService
- func (a *LLDPApiService) GetLLDPNeighbor(ctx context.Context, ifpName string) (LldpGlobalNeighbor, *http.Response, error)
- func (a *LLDPApiService) GetLLDPNeighbors(ctx context.Context) (LldpGlobalNeighbors, *http.Response, error)
type Lane
type LaneRx
type LaneTx
type LdpCapabilities
type LdpCapabilitiesLoopDetection
type LdpInstanceRef
type LdpInstanceSession
type LdpInstanceSessions
type LdpInstanceSessionsSessions
type LdpInstanceStatistics
type LdpLabelAdvertismentMode
type LdpLabelDistributionControlMode
type LdpLabelRetentionMode
type LdpPeer
type LdpRole
type LdpSession
type LdpSessionPeer
type LdpSessionState
type LdpSessionStatistics
type LdpSessionStatisticsLabels
type LdpSessionStatisticsSession
type LdpSessionStatisticsSessionEgress
type LdpSessionStatisticsSessionIngress
type LdpSessionTimers
type LinkAggregationGroup
type LinkAggregationGroupMember
type LldpGlobalNeighbor
type LldpGlobalNeighbors
type LldpNeighbor
type LldpNeighborNeighbor
type LogicalInterface
type LogicalInterfaceIflCounters
type LogicalInterfaceIflCountersRx
type LogicalInterfaceIflCountersTx
type McNextHops
type Mroutes
type NextHops
type OSPFApiService
- func (a *OSPFApiService) ClearOSPFNeighbor(ctx context.Context, instanceName string, areaId string, iflName string) (*http.Response, error)
- func (a *OSPFApiService) GetOSPFInstance(ctx context.Context, instanceName string) (OspfInstanceDetails, *http.Response, error)
- func (a *OSPFApiService) GetOSPFInstanceInterfaces(ctx context.Context, instanceName string) (OspfInstanceInterfaces, *http.Response, error)
- func (a *OSPFApiService) GetOSPFInstanceNeighbors(ctx context.Context, instanceName string) (OspfInstanceNeighbors, *http.Response, error)
- func (a *OSPFApiService) GetOSPFInstances(ctx context.Context) ([]OspfInstanceSummary, *http.Response, error)
- func (a *OSPFApiService) GetOSPFInterface(ctx context.Context, instanceName string, iflName string) (OspfInstanceInterface, *http.Response, error)
- func (a *OSPFApiService) GetOSPFInterfaces(ctx context.Context) ([]OspfInstanceInterfaces, *http.Response, error)
- func (a *OSPFApiService) GetOSPFNeighbor(ctx context.Context, instanceName string, iflName string) (OspfInstanceNeighbor, *http.Response, error)
- func (a *OSPFApiService) GetOSPFNeighbors(ctx context.Context) (OspfInstanceNeighbors, *http.Response, error)
type Optic
type OpticModule
type OpticsApiService
- func (a *OpticsApiService) DisableLaser(ctx context.Context, ifpName string) (*http.Response, error)
- func (a *OpticsApiService) EnableLaser(ctx context.Context, ifpName string) (*http.Response, error)
- func (a *OpticsApiService) GetOptic(ctx context.Context, ifpName string) (Optic, *http.Response, error)
- func (a *OpticsApiService) GetOptics(ctx context.Context) ([]Optic, *http.Response, error)
type OspfArea
type OspfInstanceDetails
type OspfInstanceGlobal
type OspfInstanceGlobalFlags
type OspfInstanceInterface
type OspfInstanceInterfaces
type OspfInstanceNeighbor
type OspfInstanceNeighbors
type OspfInstanceSummary
type OspfInterface
type OspfNeighbor
type OspfNeighborNeighbor
type PIMApiService
- func (a *PIMApiService) GetPIMInstance(ctx context.Context, instanceName string) (PimInstance, *http.Response, error)
- func (a *PIMApiService) GetPIMInstances(ctx context.Context) ([]PimInstanceRef, *http.Response, error)
- func (a *PIMApiService) GetPIMInterface(ctx context.Context, instanceName string, iflName string) (PimInterface, *http.Response, error)
- func (a *PIMApiService) GetPIMInterfaces(ctx context.Context) ([]PimInterfaces, *http.Response, error)
- func (a *PIMApiService) GetPIMNeighbor(ctx context.Context, instanceName string, neighborIp string) (PimNeighbor, *http.Response, error)
- func (a *PIMApiService) GetPIMNeighbors(ctx context.Context) ([]PimNeighbors, *http.Response, error)
type PhysicalInterface
type PhysicalInterfaceCounters
type PhysicalInterfaceCountersRx
type PhysicalInterfaceCountersTx
type PhysicalInterfaceDetail
type PhysicalInterfaceSummary
type PhysicalInterfaceSummaryRef
type PhysicalInterfaceSummaryRefLogicals
type PimDesignatedRouter
type PimInstance
type PimInstanceInterface
type PimInstanceInterfaceCapabilities
type PimInstanceInterfaceStatistics
type PimInstanceInterfaceTimers
type PimInstanceNeighbor
type PimInstanceNeighborNeighbor
type PimInstanceNeighborTimers
type PimInstanceRef
type PimInterface
type PimInterfaces
type PimMessageStatistics
type PimNeighbor
type PimNeighbors
type PingArguments
type PingStatistics
type PingStatisticsRtt
type PingStatus
type Psu
type Routes
type RoutesApiGetInstanceMulticastRoutesOpts
type RoutesApiGetInstanceUnicastRoutesOpts
type RoutesApiService
- func (a *RoutesApiService) GetInstanceMulticastRoutes(ctx context.Context, instanceName string, afi string, safi string, ...) (InstanceMulticastRoutes, *http.Response, error)
- func (a *RoutesApiService) GetInstanceUnicastRoutes(ctx context.Context, instanceName string, afi string, safi string, ...) (InstanceUnicastRoutes, *http.Response, error)
type Srgb
type StreamsApiService
- func (a *StreamsApiService) StreamPing(ctx context.Context, localVarOptionals *StreamsApiStreamPingOpts) (string, *http.Response, error)
- func (a *StreamsApiService) StreamTraceroute(ctx context.Context, localVarOptionals *StreamsApiStreamTracerouteOpts) (string, *http.Response, error)
type StreamsApiStreamPingOpts
type StreamsApiStreamTracerouteOpts
type SubscriberAccessType
type SubscriberAccountingInfo
type SubscriberAdjustedAccounting
type SubscriberApiClearSubscriberOpts
type SubscriberApiClearSubscribersOpts
type SubscriberApiGetSubscriberHistoryOpts
type SubscriberApiGetSubscribersOpts
type SubscriberApiService
- func (a *SubscriberApiService) AddTestSubscribers(ctx context.Context, body []TestAaaObject) (*http.Response, error)
- func (a *SubscriberApiService) ClearL2BSASubscriber(ctx context.Context, ifpName string, anp int) (*http.Response, error)
- func (a *SubscriberApiService) ClearSubscriber(ctx context.Context, subscriberId int, ...) (*http.Response, error)
- func (a *SubscriberApiService) ClearSubscribers(ctx context.Context, localVarOptionals *SubscriberApiClearSubscribersOpts) (*http.Response, error)
- func (a *SubscriberApiService) DisableLawfulInterception(ctx context.Context, subscriberId int, id int) (*http.Response, error)
- func (a *SubscriberApiService) EnableLawfulInterception(ctx context.Context, subscriberId int, id int, direction string, medIp string, ...) (*http.Response, error)
- func (a *SubscriberApiService) GetAccessLineInfo(ctx context.Context, subscriberId int) (AccessLineInfo, *http.Response, error)
- func (a *SubscriberApiService) GetAjdustedAccountingValues(ctx context.Context, subscriberId int) (SubscriberAdjustedAccounting, *http.Response, error)
- func (a *SubscriberApiService) GetIfpSubscriberSessionStatistics(ctx context.Context, ifpName string) (IfpSubscriberSessionStatistics, *http.Response, error)
- func (a *SubscriberApiService) GetL2BSASubscriber(ctx context.Context, ifpName string, anp int) (SubscriberSession, *http.Response, error)
- func (a *SubscriberApiService) GetL2BSASubscriberAdjustedAccountingValues(ctx context.Context, ifpName string, anp int) (SubscriberAdjustedAccounting, *http.Response, error)
- func (a *SubscriberApiService) GetSubscriber(ctx context.Context, subscriberId int) (SubscriberSession, *http.Response, error)
- func (a *SubscriberApiService) GetSubscriberHistory(ctx context.Context, localVarOptionals *SubscriberApiGetSubscriberHistoryOpts) ([]SubscriberHistory, *http.Response, error)
- func (a *SubscriberApiService) GetSubscriberSessionStatistics(ctx context.Context) (SubscriberSessionStatistics, *http.Response, error)
- func (a *SubscriberApiService) GetSubscribers(ctx context.Context, localVarOptionals *SubscriberApiGetSubscribersOpts) ([]SubscriberSessionRef, *http.Response, error)
- func (a *SubscriberApiService) GetTestSubscribers(ctx context.Context) ([]TestAaaObject, *http.Response, error)
- func (a *SubscriberApiService) RemoveTestSubscriber(ctx context.Context, subscriberId int) (*http.Response, error)
- func (a *SubscriberApiService) StoreTestSubscriber(ctx context.Context, body TestAaaObject, subscriberId int) (*http.Response, error)
- func (a *SubscriberApiService) StoreTestSubscribers(ctx context.Context, body []TestAaaObject) (*http.Response, error)
type SubscriberHistory
type SubscriberQosPolicer
type SubscriberQosProfile
type SubscriberQosProfilePolicers
type SubscriberQosShaper
type SubscriberSession
type SubscriberSessionCounters
type SubscriberSessionIpv4
type SubscriberSessionIpv4Framed
type SubscriberSessionIpv6
type SubscriberSessionIpv6Delegated
type SubscriberSessionIpv6Framed
type SubscriberSessionL2tp
type SubscriberSessionPppoe
type SubscriberSessionRef
type SubscriberSessionStatistics
type SystemApiService
- func (a *SystemApiService) GetSystemHardware(ctx context.Context) (SystemHardware, *http.Response, error)
type SystemHardware
type TestAaaObject
type Traceroute
type TracerouteArguments
type TracerouteHop
type VlanProfile
type VlanProfileBatch

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type A10NSPApiService ¶

type A10NSPApiService service

func (*A10NSPApiService) GetA10NSPL2XEndpoint ¶

func (a *A10NSPApiService) GetA10NSPL2XEndpoint(ctx context.Context, lagInterfaceName string, sVlan int) ([]A10nspConfig, *http.Response, error)

A10NSPApiService Shows an L2X endpoint. Shows the configuration of the L2X endpoint configured on the specified LAG interface with the specified S-VLAN.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param lagInterfaceName The link aggregation (LAG) interface name.
@param sVlan The S-VLAN ID.

@return []A10nspConfig

func (*A10NSPApiService) GetA10NSPL2XEndpoints ¶

func (a *A10NSPApiService) GetA10NSPL2XEndpoints(ctx context.Context) ([]A10nspConfig, *http.Response, error)

A10NSPApiService Lists all L2X endpoints. List all L2X endpoints configured on this A10-NSP switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []A10nspConfig

func (*A10NSPApiService) GetA10NSPL2XEndpointsOfLAGInterface ¶

func (a *A10NSPApiService) GetA10NSPL2XEndpointsOfLAGInterface(ctx context.Context, lagInterfaceName string) ([]A10nspConfig, *http.Response, error)

A10NSPApiService Lists all L2X endpoints. List all L2X endpoints configured on the specified LAG interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param lagInterfaceName The link aggregation (LAG) interface name.

@return []A10nspConfig

func (*A10NSPApiService) ProcessA10NSPL2XBatch ¶ added in v1.1.0

func (a *A10NSPApiService) ProcessA10NSPL2XBatch(ctx context.Context, body A10nspConfigBatch) (*http.Response, error)

A10NSPApiService Runs a A10NSP L2X configuration batch job. Adds and removes A10NSP L2X endpoints as specified in the batch job.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*A10NSPApiService) RemoveA10NSPL2XEndpoint ¶

func (a *A10NSPApiService) RemoveA10NSPL2XEndpoint(ctx context.Context, lagInterfaceName string, sVlan int) (*http.Response, error)

A10NSPApiService Removes the L2X endpoint. Removes the L2X endpoints with the specified S-VLAN from the specified LAG interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param lagInterfaceName The link aggregation (LAG) interface name.
@param sVlan The S-VLAN ID.

func (*A10NSPApiService) StoreA10NSPL2XEndpoint ¶

func (a *A10NSPApiService) StoreA10NSPL2XEndpoint(ctx context.Context, body A10nspConfig, lagInterfaceName string, sVlan int) (*http.Response, error)

A10NSPApiService Stores a L2X endpoint. Stores a L2X endpoints by either creating a new L2X endpoint on the specified LAG interface with the specified S-VLAN or updating an existing L2X endpoint configuration.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param lagInterfaceName The link aggregation (LAG) interface name.
@param sVlan The S-VLAN ID.

func (*A10NSPApiService) StoreA10NSPL2XEndpoints ¶

func (a *A10NSPApiService) StoreA10NSPL2XEndpoints(ctx context.Context, body []A10nspConfig) (*http.Response, error)

A10NSPApiService Updates all L2X endpoint configurations. Updates all L2X endpoint configurations by - adding new L2X endpoints, - updating existing L2X endpoints and - removing all L2X endpoints not listed in the request entity anymore. An empty array removes all L2X endpoints.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*A10NSPApiService) StoreA10NSPL2XEndpointsForLAGInterface ¶

func (a *A10NSPApiService) StoreA10NSPL2XEndpointsForLAGInterface(ctx context.Context, body []A10nspConfig, lagInterfaceName string) (*http.Response, error)

A10NSPApiService Updates all L2X endpoint configurations for a LAG interface. Updates all L2X endpoint configurations for a LAG interface by - adding new L2X endpoints, - updating existing L2X endpoints and - removing all L2X endpoints not listed in the request entity anymore. An empty array removes all L2X endpoints from the specified LAG interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param lagInterfaceName The link aggregation (LAG) interface name.

type A10nspConfig ¶

type A10nspConfig struct {
	LagInterfaceName string `json:"lag_interface_name,omitempty"`
	// The S-VLAN ID.
	SVlan int `json:"s_vlan,omitempty"`
	// The S-VLAN ethertype, which is either 802.1q (0x8100) or 802.1ad (0x88A8).
	SVlanEthertype string `json:"s_vlan_ethertype,omitempty"`
	// The ANP-VLAN ID.
	AnpVlan int        `json:"anp_vlan,omitempty"`
	L2x     *L2xConfig `json:"l2x,omitempty"`
}

The ephemeral configuration of a A10-NSP L2X service. This configuration is lost if the switch reboots.

type A10nspConfigBatch ¶ added in v1.1.0

type A10nspConfigBatch struct {
	// A10NSP L2X endpoints to be removed.
	Remove []A10nspConfig `json:"remove,omitempty"`
	// A10NSP L2X endpoints to be stored.
	Store []A10nspConfig `json:"store,omitempty"`
}

A10NSP endpoint configuration batch instructions.

type APIClient ¶

type APIClient struct {
	A10NSPApi *A10NSPApiService

	AccessApi *AccessApiService

	ActionsApi *ActionsApiService

	BGPApi *BGPApiService

	ISISApi *ISISApiService

	InterfacesApi *InterfacesApiService

	L2BSAApi *L2BSAApiService

	LDPApi *LDPApiService

	LLDPApi *LLDPApiService

	OSPFApi *OSPFApiService

	OpticsApi *OpticsApiService

	PIMApi *PIMApiService

	RoutesApi *RoutesApiService

	StreamsApi *StreamsApiService

	SubscriberApi *SubscriberApiService

	SystemApi *SystemApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the RBFS Operational State API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AccessApiAddVLANProfileOpts ¶

type AccessApiAddVLANProfileOpts struct {
	OuterVlanMin optional.Int
	OuterVlanMax optional.Int
	InnerVlanMin optional.Int
	InnerVlanMax optional.Int
}

type AccessApiDeleteVLANProfileOpts ¶

type AccessApiDeleteVLANProfileOpts struct {
	OuterVlanMin optional.Int
	OuterVlanMax optional.Int
	InnerVlanMin optional.Int
	InnerVlanMax optional.Int
}

type AccessApiFlushVLANProfilesOpts ¶

type AccessApiFlushVLANProfilesOpts struct {
	IfpName optional.String
}

type AccessApiGetVLANProfilesOpts ¶

type AccessApiGetVLANProfilesOpts struct {
	IfpName optional.String
}

type AccessApiService ¶

type AccessApiService service

func (*AccessApiService) AddVLANProfile ¶

func (a *AccessApiService) AddVLANProfile(ctx context.Context, body VlanProfile, ifpName string, localVarOptionals *AccessApiAddVLANProfileOpts) (*http.Response, error)

func (*AccessApiService) DeleteVLANProfile ¶

func (a *AccessApiService) DeleteVLANProfile(ctx context.Context, ifpName string, localVarOptionals *AccessApiDeleteVLANProfileOpts) (*http.Response, error)

func (*AccessApiService) FlushVLANProfiles ¶

func (a *AccessApiService) FlushVLANProfiles(ctx context.Context, localVarOptionals *AccessApiFlushVLANProfilesOpts) (*http.Response, error)

func (*AccessApiService) GetVLANProfiles ¶

func (a *AccessApiService) GetVLANProfiles(ctx context.Context, localVarOptionals *AccessApiGetVLANProfilesOpts) ([]VlanProfile, *http.Response, error)

func (*AccessApiService) ProcessVLANProfilesBatch ¶ added in v1.1.0

func (a *AccessApiService) ProcessVLANProfilesBatch(ctx context.Context, body VlanProfileBatch) (*http.Response, error)

AccessApiService Runs a VLAN profile configuration batch job. Stores and removes all VLAN profiles as specified in the batch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*AccessApiService) StoreVLANProfiles ¶

func (a *AccessApiService) StoreVLANProfiles(ctx context.Context, body []VlanProfile, localVarOptionals *AccessApiStoreVLANProfilesOpts) (*http.Response, error)

type AccessApiStoreVLANProfilesOpts ¶

type AccessApiStoreVLANProfilesOpts struct {
	IfpName optional.String
}

type AccessLineInfo ¶

type AccessLineInfo struct {
	// The Agent-Circuit-ID (ACI).
	AgentCircuitId string `json:"agent_circuit_id,omitempty"`
	// The Agent-Remote-ID (ARI).
	AgentRemoteId string                    `json:"agent_remote_id,omitempty"`
	Upstream      *AccessLineInfoUpstream   `json:"upstream,omitempty"`
	Downstream    *AccessLineInfoDownstream `json:"downstream,omitempty"`
	DataLink      *AccessLineInfoDataLink   `json:"data_link,omitempty"`
	// DSL type
	DslType string `json:"dsl_type,omitempty"`
	// PON type
	PonType string `json:"pon_type,omitempty"`
}

The access line information.

type AccessLineInfoDataLink ¶

type AccessLineInfoDataLink struct {
	// Data link type field.
	DataLinkType string `json:"data_link_type,omitempty"`
	// Data link encapsulation 1 field.
	Encapsulation1 string `json:"encapsulation_1,omitempty"`
	// Data link encapsulation 2 field.
	Encapsulation2 string `json:"encapsulation_2,omitempty"`
}

Access-Loop-Encapsulation.

type AccessLineInfoDownstream ¶

type AccessLineInfoDownstream struct {
	// Actual downstream data rate.
	ActualRate int `json:"actual_rate,omitempty"`
	// Minimum downstream data rate.
	MinRate int `json:"min_rate,omitempty"`
	// Attainable downstream data rate.
	AttainableRate int `json:"attainable_rate,omitempty"`
	// Maximum downstream data rate.
	MaxRate int `json:"max_rate,omitempty"`
	// Minimum downstream data rate in low power state.
	MinRateLowPower int `json:"min_rate_low_power,omitempty"`
	// Maximum downstream interleaving delay.
	MaxInterleaveDelay int `json:"max_interleave_delay,omitempty"`
	// Actual downstream interleaving delay.
	ActualInterleaveDelay int `json:"actual_interleave_delay,omitempty"`
	// Downstream Expected Throughput (ETR).
	ExpectedThroughput int `json:"expected_throughput,omitempty"`
	// Downstream Attainable Expected Throughput (ATTETR).
	AttainableExpectedThroughput int `json:"attainable_expected_throughput,omitempty"`
	// Downstream Gamma Data Rate (GDR).
	GammaDataRate int `json:"gamma_data_rate,omitempty"`
	// Downstream Attainable Gamma Data Rate (ATTGDR).
	AttainableGammaDataRate int `json:"attainable_gamma_data_rate,omitempty"`
	// ONT/ONU downstream average data rate.
	OntOnuAverageRate int `json:"ont_onu_average_rate,omitempty"`
	// ONT/ONU downstream peak data rate.
	OntOnuPeakRate int `json:"ont_onu_peak_rate,omitempty"`
	// PON tree downstream maximum data rate.
	PonMaxRate int `json:"pon_max_rate,omitempty"`
}

Downstream access line attributes.

type AccessLineInfoUpstream ¶

type AccessLineInfoUpstream struct {
	// Actual upstream data rate.
	ActualRate int `json:"actual_rate,omitempty"`
	// Minimum upstream data rate.
	MinRate int `json:"min_rate,omitempty"`
	// Attainable upstream data rate.
	AttainableRate int `json:"attainable_rate,omitempty"`
	// Maximum upstream data rate.
	MaxRate int `json:"max_rate,omitempty"`
	// Minimum upstream data rate in low power state.
	MinRateLowPower int `json:"min_rate_low_power,omitempty"`
	// Maximum upstream interleaving delay.
	MaxInterleaveDelay int `json:"max_interleave_delay,omitempty"`
	// Actual upstream interleaving delay.
	ActualInterleaveDelay int `json:"actual_interleave_delay,omitempty"`
	// Expected Throughput (ETR).
	ExpectedThroughput int `json:"expected_throughput,omitempty"`
	// Attainable Expected Throughput (ATTETR).
	AttainableExpectedThroughput int `json:"attainable_expected_throughput,omitempty"`
	// Gamma Data Rate (GDR).
	GammaDataRate int `json:"gamma_data_rate,omitempty"`
	// Attainable Gamma Data Rate (ATTGDR).
	AttainableGammaDataRate int `json:"attainable_gamma_data_rate,omitempty"`
	// ONT/ONU upstream maximum data rate.
	OntOnuMaxRate int `json:"ont_onu_max_rate,omitempty"`
	// ONT/ONU upstream assured data rate.
	OntOnuAssuredRate int `json:"ont_onu_assured_rate,omitempty"`
	// PON tree upstream maximum data rate.
	PonMaxRate int `json:"pon_max_rate,omitempty"`
}

Upstream access line attributes.

type ActionsApiPingOpts ¶

type ActionsApiPingOpts struct {
	DestinationIp   optional.String
	DestinationAaaa optional.String
	DestinationA    optional.String
	SourceIp        optional.String
	SourceIfl       optional.String
	InstanceName    optional.String
	Count           optional.Int
	Interval        optional.Float32
	Size            optional.Int
	Ttl             optional.Int
}

type ActionsApiService ¶

type ActionsApiService service

func (*ActionsApiService) Ping ¶

func (a *ActionsApiService) Ping(ctx context.Context, localVarOptionals *ActionsApiPingOpts) (PingStatus, *http.Response, error)

func (*ActionsApiService) Traceroute ¶

func (a *ActionsApiService) Traceroute(ctx context.Context, localVarOptionals *ActionsApiTracerouteOpts) (Traceroute, *http.Response, error)

type ActionsApiTracerouteOpts ¶

type ActionsApiTracerouteOpts struct {
	DestinationIp   optional.String
	DestinationAaaa optional.String
	DestinationA    optional.String
	SourceIp        optional.String
	SourceIfl       optional.String
	InstanceName    optional.String
	MaxHops         optional.Int
	Size            optional.Int
	Interval        optional.Float32
}

type AllOfIsisInstanceInterfacesSegmentRouting ¶ added in v1.1.0

type AllOfIsisInstanceInterfacesSegmentRouting struct {
	// SRGB start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// SRGB length.
	SrgbRange int `json:"srgb_range,omitempty"`
	// SR indices.
	SrIds []interface{} `json:"sr_ids,omitempty"`
}

Segment routing settings.

type AllOfIsisInstanceSegmentRouting ¶ added in v1.1.0

type AllOfIsisInstanceSegmentRouting struct {
	// SRGB start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// SRGB length.
	SrgbRange int `json:"srgb_range,omitempty"`
	// SR indices.
	SrIds []interface{} `json:"sr_ids,omitempty"`
}

Segment routing settings.

type AllOfIsisInterfaceSegmentRouting ¶ added in v1.1.0

type AllOfIsisInterfaceSegmentRouting struct {
	// IPv4 SR index
	Ipv4Sid int `json:"ipv4_sid,omitempty"`
	// IPv6 SR index
	Ipv6Sid int `json:"ipv6_sid,omitempty"`
	// IPv4 SR anycast index
	Ipv4AnycastSid int `json:"ipv4_anycast_sid,omitempty"`
	// IPv6 SR anycast index
	Ipv6AnycastSid int `json:"ipv6_anycast_sid,omitempty"`
	// SRGB start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// SRGB length.
	SrgbRange int `json:"srgb_range,omitempty"`
}

Segment routing settings of this interface.

type BGPApiService ¶

type BGPApiService service

func (*BGPApiService) ClearBGPInstancePeerings ¶

func (a *BGPApiService) ClearBGPInstancePeerings(ctx context.Context, instanceName string) (*http.Response, error)

BGPApiService Clears all instance BGP peerings. Clears all BGP peerings associated with the specified BGP instance. The API confirms that the clear request has been accepted and tells RBFS to re-establish the BGP peerings. This is an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName BGP routing instance name.

func (*BGPApiService) ClearBGPPeering ¶

func (a *BGPApiService) ClearBGPPeering(ctx context.Context, instanceName string, peerIp string) (*http.Response, error)

BGPApiService Clears a BGP peering. Clears a BGP peerings. The management API confirms that the clear request has been accepted and delegates the clear request to RBFS. This is an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName BGP routing instance name.
@param peerIp Peer IPv4 or peer IPv6 address.

func (*BGPApiService) GetBGPInstance ¶

func (a *BGPApiService) GetBGPInstance(ctx context.Context, instanceName string) (BgpInstance, *http.Response, error)

BGPApiService Get BGP instance details. Provides BGP instance details including information about the configured peerings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName BGP routing instance name.

@return BgpInstance

func (*BGPApiService) GetBGPInstances ¶

func (a *BGPApiService) GetBGPInstances(ctx context.Context) ([]BgpInstanceRef, *http.Response, error)

BGPApiService Lists all BGP instances. Lists all BGP instances, including auto-discovered fabric peerings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []BgpInstanceRef

func (*BGPApiService) GetBGPPeering ¶

func (a *BGPApiService) GetBGPPeering(ctx context.Context, instanceName string, peerIp string) (BgpPeering, *http.Response, error)

BGPApiService Provides BGP peering details Returns BGP peering details including summary statistics of received and sent prefixes per AFI/SAFI.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName BGP routing instance name.
@param peerIp The BGP peering details.

@return BgpPeering

func (*BGPApiService) GetBGPPeerings ¶

func (a *BGPApiService) GetBGPPeerings(ctx context.Context) ([]BgpInstancePeerings, *http.Response, error)

BGPApiService Lists all BGP peerings grouped by instance. Provides a list of all BGP peerings of all BGP instances including the total count of received and sent prefixes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []BgpInstancePeerings

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BgpAfiSafiStatistics ¶

type BgpAfiSafiStatistics struct {
	// The address family identifier and subaddress family identifier as single string using a hyphen as delimiter.
	AfiSafi string `json:"afi_safi,omitempty"`
	// The address family identifier.
	AfiName string `json:"afi_name,omitempty"`
	// The subaddress family identifer.
	SafiName string `json:"safi_name,omitempty"`
	// The number of sent prefixes.
	PrefixesSent int `json:"prefixes_sent,omitempty"`
	// The number of received prefixes.
	PrefixesReceived int `json:"prefixes_received,omitempty"`
}

type BgpInstance ¶

type BgpInstance struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The AS number.
	Asn int64 `json:"asn,omitempty"`
	// Unique router ID
	RouterId string `json:"router_id,omitempty"`
	// The BGP cluster ID this router is member of.
	ClusterId string `json:"cluster_id,omitempty"`
	// The BGP host name.  The host_name has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The BGP hostname.
	Hostname string `json:"hostname,omitempty"`
	// The BGP domain name.
	DomainName string `json:"domain_name,omitempty"`
	// BGP version.
	BgpVersion int `json:"bgp_version,omitempty"`
	// The IP ToS (type of service) value set in all outgoing BGP packets.
	BgpIpTos       int                         `json:"bgp_ip_tos,omitempty"`
	Capabilities   *BgpInstanceCapabilities    `json:"capabilities,omitempty"`
	RouteSelection *BgpInstanceRouteSelection  `json:"route_selection,omitempty"`
	Timers         *BgpInstanceTimers          `json:"timers,omitempty"`
	Peerings       *BgpInstancePeeringsSummary `json:"peerings,omitempty"`
}

BGP instance details.

type BgpInstanceCapabilities ¶

type BgpInstanceCapabilities struct {
	// Accept 4-byte ASN numbers.
	As4Capable bool `json:"as4_capable,omitempty"`
	// Resend all prefixes if a peer asks for it.
	RouteRefreshCapable bool `json:"route_refresh_capable,omitempty"`
	// Preserve forwarding state during BGP restart.
	GracefulRestartCapable bool `json:"graceful_restart_capable,omitempty"`
	// Reject all routes from eBGP peers if the peer does not add its AS  as first AS in the AS path.
	EnforceFirstAs bool `json:"enforce_first_as,omitempty"`
}

Set of configured BGP capabilities.

type BgpInstancePeerings ¶

type BgpInstancePeerings struct {
	// BGP instance name
	InstanceName string `json:"instance_name,omitempty"`
	// The local AS number.
	Asn int64 `json:"asn,omitempty"`
	// The local router identifier.
	RouterId string `json:"router_id,omitempty"`
	// The BGP host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The BGP hostname.
	Hostname string `json:"hostname,omitempty"`
	// The BGP domain name.
	DomainName string `json:"domain_name,omitempty"`
	// The BGP cluster ID.
	ClusterId string                      `json:"cluster_id,omitempty"`
	Peerings  *BgpInstancePeeringsSummary `json:"peerings,omitempty"`
}

BGP peerings grouped by instance.

type BgpInstancePeeringsSummary ¶

type BgpInstancePeeringsSummary struct {
	// Number of peerings in active state.
	ActiveCount int `json:"active_count,omitempty"`
	// Number of peerings in idle state.
	IdleCount int `json:"idle_count,omitempty"`
	// Number of peerings in connect state.
	ConnectCount int `json:"connect_count,omitempty"`
	// Number of peerings in opensent state.
	OpensentCount int `json:"opensent_count,omitempty"`
	// Number of peerings in openconfirm state.
	OpenconfirmCount int `json:"openconfirm_count,omitempty"`
	// Number of peerings in established state.
	EstablishedCount int `json:"established_count,omitempty"`
	// Array of BGP peering references.
	Peerings []BgpPeeringRef `json:"peerings,omitempty"`
}

A summary of the BGP instance peerings including the number of peerings per state and a reference to each peering. The reference allows obtaining the BPG peering details.

type BgpInstanceRef ¶

type BgpInstanceRef struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The AS number.
	Asn int64 `json:"asn,omitempty"`
	// Unique router ID.
	RouterId string `json:"router_id,omitempty"`
}

A BGP instance reference contains the information to render a list of configured BGP instances and to navigate to BGP instance details.

type BgpInstanceRouteSelection ¶

type BgpInstanceRouteSelection struct {
	// A constant BGP multi exit discriminator (MED) value shared as metric with all peers.  The metric is derived from the IGP if not specified.
	Med int `json:"med,omitempty"`
	// The AS-local preference value of this router. The router with the highest local preference  is preferred for routing traffic to an external AS if multiple paths exist.
	LocalPreference int `json:"local_preference,omitempty"`
	// The preference value for IBGP routes,  i.e. routes learned from BGP peers in the same AS.
	IbgpPreference int `json:"ibgp_preference,omitempty"`
	// The preference value for EBGP routes,  i.e. routes learned from BGP peers in an external AS.
	EbgpPreference int `json:"ebgp_preference,omitempty"`
	// Ignore ASN when comparing MED values for route selection.
	AlwaysCompareMed bool `json:"always_compare_med,omitempty"`
	// Ignore AS path length for route selection.
	IgnoreAsPathLength bool `json:"ignore_as_path_length,omitempty"`
	// Ignore local preference for route selection.
	IgnoreLocalPref bool `json:"ignore_local_pref,omitempty"`
	// Ignore route source for route selection.
	IgnoreRouteSource bool `json:"ignore_route_source,omitempty"`
	// Ignore origin for route selection.
	IgnoreOrigin bool `json:"ignore_origin,omitempty"`
	// Ignore MED for route selection. bgp_always_compe_med has no effect if bgp_ignore_med is set to true.
	IgnoreMed bool `json:"ignore_med,omitempty"`
	// Ignore route type for route selection.
	IgnoreRouteType bool `json:"ignore_route_type,omitempty"`
	// Ignore up-time for route selection.
	IgnoreUpTime bool `json:"ignore_up_time,omitempty"`
	// Ignore route ID for route selection.
	IgnoreRouterId bool `json:"ignore_router_id,omitempty"`
	// Ignore cluster length for route selection.
	IgnoreClusterLength bool `json:"ignore_cluster_length,omitempty"`
	// Ignore peer IP for route selection.
	IgnorePeerIp bool `json:"ignore_peer_ip,omitempty"`
}

BGP best-route selection flags and default values.

type BgpInstanceTimers ¶

type BgpInstanceTimers struct {
	// Graceful restart (GR) stale timer value in seconds.
	GrStaleTime int `json:"gr_stale_time,omitempty"`
	// Graceful restart (GR) purge timer value in seconds.
	GrPurgeTime int `json:"gr_purge_time,omitempty"`
	// Graceful restart (GR) restart timer value in seconds.
	GrRestartTime int `json:"gr_restart_time,omitempty"`
	// BGP hold timer value in seconds. A BGP peer is considered down if the hold timer expires before receiving keep-alive messages from the BGP peer.  Every received hello message resets the hold timer.
	HoldTime int `json:"hold_time,omitempty"`
	// BGP keep-alive timer value methods in seconds. The router sends a hello message to a peer when the keep-alive timer expires.
	KeepAliveTime int `json:"keep_alive_time,omitempty"`
	// BGP connect timer value in seconds. An active BGP peering tries to establish the peering every bgp_connect_time seconds.
	ConnectTime int `json:"connect_time,omitempty"`
}

The BGP timers.

type BgpPeer ¶

type BgpPeer struct {
	// The peer IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The peer IPv4 address
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The peer router ID.
	RouterId string `json:"router_id,omitempty"`
	// The peer AS number.
	Asn int64 `json:"asn,omitempty"`
	// The peer host name. The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The peer hostname.
	Hostname string `json:"hostname,omitempty"`
	// The peer domain name.
	DomainName string `json:"domain_name,omitempty"`
	// The destination port to connect to this peer.
	DestinationPort int `json:"destination_port,omitempty"`
}

Informations about the BGP peer.

type BgpPeering ¶

type BgpPeering struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The administrative peering state.
	AdministrativeState string    `json:"administrative_state,omitempty"`
	BgpState            *BgpState `json:"bgp_state,omitempty"`
	// Last BGP state transition.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	// The reason for the last BGP reset.
	LastResetReason string `json:"last_reset_reason,omitempty"`
	// The local AS number.
	Asn     int64  `json:"asn,omitempty"`
	IflName string `json:"ifl_name,omitempty"`
	// The local IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The local IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The peering source port.
	SourcePort int `json:"source_port,omitempty"`
	// The local router ID
	RouterId string `json:"router_id,omitempty"`
	// The local BGP host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The local BGP hostname.
	Hostname string `json:"hostname,omitempty"`
	// The local BGP domain name.
	DomainName string `json:"domain_name,omitempty"`
	// The BGP peering type.
	PeeringType string `json:"peering_type,omitempty"`
	// The BGP peer group name.
	PeerGroupName string                  `json:"peer_group_name,omitempty"`
	Peer          *BgpPeer                `json:"peer,omitempty"`
	Capabilities  *BgpPeeringCapabilities `json:"capabilities,omitempty"`
	Statistics    *BgpPeeringStatistics   `json:"statistics,omitempty"`
	Timers        *BgpPeeringTimers       `json:"timers,omitempty"`
}

BGP peering details.

type BgpPeeringCapabilities ¶

type BgpPeeringCapabilities struct {
	// Accept 4-byte AS number.
	As4Capable bool `json:"as4_capable,omitempty"`
	// Sent AS4 capability status.
	As4CapableSent bool `json:"as4_capable_sent,omitempty"`
	// Received AS4 capability status.
	As4CapableReceived bool `json:"as4_capable_received,omitempty"`
	// Resend all prefixes if the peer asks for it.
	RouteRefreshCapable bool `json:"route_refresh_capable,omitempty"`
	// Sent RR capability status.
	RouteRefreshCapableSent bool `json:"route_refresh_capable_sent,omitempty"`
	// Received RR capability status.
	RouteRefreshCapableReceived bool `json:"route_refresh_capable_received,omitempty"`
	// Preserve forwarding state during BGP restart.
	GracefulRestartCapable bool `json:"graceful_restart_capable,omitempty"`
	// Sent graceful restart capability status.
	GracefulRestartCapableSent bool `json:"graceful_restart_capable_sent,omitempty"`
	// Received graceful restart capability status.
	GracefulRestartCapableReceived bool `json:"graceful_restart_capable_received,omitempty"`
	// Use the link-local IPv6 addresses to establish this peering.
	LinkLocalOnly bool `json:"link_local_only,omitempty"`
	// Sent link local only capability status.
	LinkLocalOnlySent bool `json:"link_local_only_sent,omitempty"`
	// Received link local only capability status.
	LinkLocalOnlyReceived bool `json:"link_local_only_received,omitempty"`
	// Whether this peering supports accumulated IGP metrics.
	AigpCapable bool `json:"aigp_capable,omitempty"`
	// Sent AIGP capability status.
	AigpCapableSent bool `json:"aigp_capable_sent,omitempty"`
	// Received AIGP capability status.
	AigpCapableReceived bool `json:"aigp_capable_received,omitempty"`
	// Negotiated AFI/SAFI for which prefixes (NLRIs) are exchanged.
	AfiSafis []string `json:"afi_safis,omitempty"`
	// Sent AFI/SAFIs.
	AfiSafisSent []string `json:"afi_safis_sent,omitempty"`
	// Received AFI/SAFIs.
	AfiSafisReceived []string `json:"afi_safis_received,omitempty"`
	// Negotiated AFI-SAFIs with extended next hop configuration.
	ExtendedNextHops []string `json:"extended_next_hops,omitempty"`
	// Sent extended next hop configuration.
	ExtendedNextHopsSent []string `json:"extended_next_hops_sent,omitempty"`
	// Received extended next hop configuration.
	ExtendedNextHopsReceived []string `json:"extended_next_hops_received,omitempty"`
	// AFI/SAFIs with additional paths enabled.
	AdditionalPaths []float64 `json:"additional_paths,omitempty"`
	// Send additional paths configuration.
	AdditionalPathsSend []float64 `json:"additional_paths_send,omitempty"`
	// Received additional paths configuration.
	AdditionalPathsReceived []float64 `json:"additional_paths_received,omitempty"`
	// Flag indicating whether 6PE is enabled. PE6 allows establishing IPv6 reachability over an IPv4/MPLS core.
	Var6peEnabled bool `json:"6pe_enabled,omitempty"`
	// Accept any remote AS number. If set to true, the remote AS is dynamically configured.
	AnyAs bool `json:"any_as,omitempty"`
}

Configured, received and negotiated peering capabilities.

type BgpPeeringRef ¶

type BgpPeeringRef struct {
	// The administrative peering state.
	AdministrativeState string    `json:"administrative_state,omitempty"`
	BgpState            *BgpState `json:"bgp_state,omitempty"`
	// Last BGP state transition.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	// Last session reset reason.
	LastResetReason string `json:"last_reset_reason,omitempty"`
	// The local AS number.
	Asn int64 `json:"asn,omitempty"`
	// Number of BGP session flaps.
	BgpSessionFlaps int    `json:"bgp_session_flaps,omitempty"`
	IflName         string `json:"ifl_name,omitempty"`
	// The local IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The local IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The BGP peering type.
	PeeringType string   `json:"peering_type,omitempty"`
	Peer        *BgpPeer `json:"peer,omitempty"`
}

A reference to a BGP peering. This information can be used to obtain the more detailed BGPPeering object.

type BgpPeeringStatistics ¶

type BgpPeeringStatistics struct {
	// Number of session flaps.
	BgpSessionFlaps int            `json:"bgp_session_flaps,omitempty"`
	BgpSession      *BgpStatistics `json:"bgp_session,omitempty"`
	Total           *BgpStatistics `json:"total,omitempty"`
	// Number of received and sent prefixed grouped by AFI/SAFI.
	Routes []BgpAfiSafiStatistics `json:"routes,omitempty"`
}

BGP peering summary statistics including received / sent prefixes per AFI/SAFI

type BgpPeeringTimers ¶

type BgpPeeringTimers struct {
	// The keep alive timer value in seconds.
	KeepAliveTimer int `json:"keep_alive_timer,omitempty"`
	// The negotiated keep-alive time in seconds.
	KeepAliveTime int `json:"keep_alive_time,omitempty"`
	// The received keep alive time in seconds.
	KeepAliveTimeReceived int `json:"keep_alive_time_received,omitempty"`
	// The configured keep alive time seconds.
	KeepAliveTimeSent int `json:"keep_alive_time_sent,omitempty"`
	// The hold timer value in seconds.
	HoldTimer int `json:"hold_timer,omitempty"`
	// The negotiated hold time in seconds.
	HoldTime int `json:"hold_time,omitempty"`
	// The received hold time in seconds.
	HoldTimeReceived int `json:"hold_time_received,omitempty"`
	// The sent hold time in seconds.
	HoldTimeSent int `json:"hold_time_sent,omitempty"`
	// The connect timer value in seconds.
	ConnectTimer int `json:"connect_timer,omitempty"`
	// The negotiated connect time in seconds.
	ConnectTime int `json:"connect_time,omitempty"`
	// The sent connect time in seconds.
	ConnectTimeSent int `json:"connect_time_sent,omitempty"`
	// The received connect time in seconds.
	ConnectTimeReceived int `json:"connect_time_received,omitempty"`
}

BGP timers and their current values.

type BgpState ¶

type BgpState string

BgpState : BGP FSM state.

const (
	CONNECT_BgpState      BgpState = "CONNECT"
	IDLE_BgpState         BgpState = "IDLE"
	OPEN_CONFIRM_BgpState BgpState = "OPEN_CONFIRM"
	OPEN_SENT_BgpState    BgpState = "OPEN_SENT"
	ACTIVE_BgpState       BgpState = "ACTIVE"
	ESTABLISHED_BgpState  BgpState = "ESTABLISHED"
)

List of BGPState

type BgpStatistics ¶

type BgpStatistics struct {
	Ingress *BgpStatisticsIngress `json:"ingress,omitempty"`
	Egress  *BgpStatisticsEgress  `json:"egress,omitempty"`
}

BGP session statistics.

type BgpStatisticsEgress ¶

type BgpStatisticsEgress struct {
	// Number of sent open messages.
	OpenCount int `json:"open_count,omitempty"`
	// Number of sent update messages.
	UpdateCount int `json:"update_count,omitempty"`
	// Number of sent keep-alive messages.
	KeepAliveCount int `json:"keep_alive_count,omitempty"`
	// Number of sent notify messages.
	NotifyCount int `json:"notify_count,omitempty"`
	// Number of sent route-refresh messages.
	RouteRefreshCount int `json:"route_refresh_count,omitempty"`
}

type BgpStatisticsIngress ¶

type BgpStatisticsIngress struct {
	// Number of received open messages.
	OpenCount int `json:"open_count,omitempty"`
	// Number of received update messages.
	UpdateCount int `json:"update_count,omitempty"`
	// Number of received keep-alive messages.
	KeepAliveCount int `json:"keep_alive_count,omitempty"`
	// Number of received notify messages.
	NotifyCount int `json:"notify_count,omitempty"`
	// Number of received route-refresh messages.
	RouteRefreshCount int `json:"route_refresh_count,omitempty"`
}

type Chassis ¶ added in v1.1.0

type Chassis struct {
	// The product name.
	ProductName string `json:"product_name,omitempty"`
	// The vendor name.
	VendorName string `json:"vendor_name,omitempty"`
	// The system MAC address.
	Mac string `json:"mac,omitempty"`
	// The date when the system has been manufactured.
	ManufactureDate time.Time `json:"manufacture_date,omitempty"`
	// The manufacturer name.
	Manufacturer string `json:"manufacturer,omitempty"`
	// The ONIE SW version.
	OnieVersion string `json:"onie_version,omitempty"`
	// The diag SW version.
	DiagVersion string `json:"diag_version,omitempty"`
	// The part number.
	PartNumber string `json:"part_number,omitempty"`
	// The platform name.
	PlatformName string `json:"platform_name,omitempty"`
	// The chassis serial number.
	SerialNumber string `json:"serial_number,omitempty"`
	// The country where the system has been manufactured.
	CountryCode string `json:"country_code,omitempty"`
}

The hardware chassis.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type Fan ¶ added in v1.1.0

type Fan struct {
	// The name of the fan.
	FanName string `json:"fan_name,omitempty"`
	// The module on which the fan resides.
	Location string `json:"location,omitempty"`
	// The fan model.
	Model string `json:"model,omitempty"`
	// The fan serial number.
	SerialNumber string `json:"serial_number,omitempty"`
	// The presense and operational state of the fan.
	Status []string `json:"status,omitempty"`
}

The fan module.

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ISISApiService ¶

type ISISApiService service

func (*ISISApiService) ClearISISInstanceNeighbors ¶

func (a *ISISApiService) ClearISISInstanceNeighbors(ctx context.Context, instanceName string) (*http.Response, error)

ISISApiService Clears the IS-IS instance adjacency. Clears all IS-IS instance sessions to re-establish them. Watch the IS-IS neighbors state to track the session re-establishment progress.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The IS-IS instance name.

func (*ISISApiService) ClearISISInterfaceNeighbors ¶

func (a *ISISApiService) ClearISISInterfaceNeighbors(ctx context.Context, instanceName string, iflName string) (*http.Response, error)

ISISApiService Clears all IS-IS neighbors connected through the specified logical interface. Clears the IS-IS neighbor to re-establish the adjacency. Watch the neighbor state to track the resetablishment progress.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The IS-IS instance name.
@param iflName The logical interface the neighbor is connected to.

func (*ISISApiService) GetISISInstance ¶

func (a *ISISApiService) GetISISInstance(ctx context.Context, instanceName string) (IsisInstance, *http.Response, error)

ISISApiService Shows IS-IS instance details. Shows the details of an IS-IS instance including the discovered neighbors.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The IS-IS instance name.

@return IsisInstance

func (*ISISApiService) GetISISInstances ¶

func (a *ISISApiService) GetISISInstances(ctx context.Context) ([]IsisInstanceRef, *http.Response, error)

ISISApiService Lists all IS-IS instances. Lists all IS-IS instances including administrative and operational state information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []IsisInstanceRef

func (*ISISApiService) GetISISInterface ¶

func (a *ISISApiService) GetISISInterface(ctx context.Context, instanceName string, iflName string) (IsisInstanceInterface, *http.Response, error)

ISISApiService Shows details of a IS-IS interface. Shows details of an IS-IS interface including statistics.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The IS-IS instance name.
@param iflName The logical interface name.

@return IsisInstanceInterface

func (*ISISApiService) GetISISInterfaces ¶

func (a *ISISApiService) GetISISInterfaces(ctx context.Context) ([]IsisInstanceInterfaces, *http.Response, error)

ISISApiService Lists all IS-IS interfaces. Lists all IS-IS interfaces grouped by IS-IS instances.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []IsisInstanceInterfaces

func (*ISISApiService) GetISISNeighbor ¶

func (a *ISISApiService) GetISISNeighbor(ctx context.Context, instanceName string, iflName string) (IsisInstanceNeighbor, *http.Response, error)

ISISApiService Shows details of a IS-IS neighbor. Shows details of an IS-IS neighbor including statistics.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The IS-IS instance name.
@param iflName The logical interface the neighbor is connected to.

@return IsisInstanceNeighbor

func (*ISISApiService) GetISISNeighbors ¶

func (a *ISISApiService) GetISISNeighbors(ctx context.Context) ([]IsisInstanceNeighbors, *http.Response, error)

ISISApiService Lists all IS-IS neighbors. Lists all IS-IS neighbors grouped by IS-IS instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []IsisInstanceNeighbors

type IfpSubscriberSessionStatistics ¶ added in v1.1.0

type IfpSubscriberSessionStatistics struct {
	IfpName string                     `json:"ifp_name,omitempty"`
	Total   *SubscriberSessionCounters `json:"total,omitempty"`
	Ipoe    *SubscriberSessionCounters `json:"ipoe,omitempty"`
	L2bsa   *SubscriberSessionCounters `json:"l2bsa,omitempty"`
	L2tp    *SubscriberSessionCounters `json:"l2tp,omitempty"`
	Pppoe   *SubscriberSessionCounters `json:"pppoe,omitempty"`
	Test    *SubscriberSessionCounters `json:"test,omitempty"`
}

Holds the subscriber session counters of a single physical interface.

type InstanceMulticastRoutes ¶ added in v1.1.0

type InstanceMulticastRoutes struct {
	// The routing instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The address family.
	Afi string `json:"afi,omitempty"`
	// The sub-address family.
	Safi            string    `json:"safi,omitempty"`
	MulticastRoutes []Mroutes `json:"multicast_routes,omitempty"`
}

Multicast route information for an instance and AFI/SAFI.

type InstanceUnicastRoutes ¶ added in v1.1.0

type InstanceUnicastRoutes struct {
	// The routing instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The address family.
	Afi string `json:"afi,omitempty"`
	// The sub-address family.
	Safi   string   `json:"safi,omitempty"`
	Routes []Routes `json:"routes,omitempty"`
}

Route information for an instance and AFI/SAFI.

type InterfacesApiGetPhysicalInterfaceOpts ¶

type InterfacesApiGetPhysicalInterfaceOpts struct {
	Optics optional.Bool
}

type InterfacesApiGetPhysicalInterfacesOpts ¶ added in v1.1.0

type InterfacesApiGetPhysicalInterfacesOpts struct {
	Counters optional.Bool
}

type InterfacesApiService ¶

type InterfacesApiService service

func (*InterfacesApiService) ClearInterfaceCounters ¶ added in v1.1.0

func (a *InterfacesApiService) ClearInterfaceCounters(ctx context.Context, ifName string) (*http.Response, error)

InterfacesApiService Clears physical or logical interface counters. Clears the counters of a physical or logical interface with the given name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifName The physical or logical interface name.

func (*InterfacesApiService) ClearLogicalInterfaceCounters ¶ added in v1.1.0

func (a *InterfacesApiService) ClearLogicalInterfaceCounters(ctx context.Context, iflName string) (*http.Response, error)

InterfacesApiService Clears logical interface counters. Clears the counters of the logical interface with the given name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.

func (*InterfacesApiService) ClearPhysicalInterfaceCounters ¶ added in v1.1.0

func (a *InterfacesApiService) ClearPhysicalInterfaceCounters(ctx context.Context, ifpName string) (*http.Response, error)

InterfacesApiService Clears physical interface counters. Clears the counters of the physical interface with the given name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

func (*InterfacesApiService) DisableInterface ¶

func (a *InterfacesApiService) DisableInterface(ctx context.Context, ifName string) (*http.Response, error)

InterfacesApiService Disables a physical or a logical interface name. Disables the specified physical or a logical interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifName The physical or logical interface name.

func (*InterfacesApiService) DisableLogicalInterface ¶

func (a *InterfacesApiService) DisableLogicalInterface(ctx context.Context, iflName string) (*http.Response, error)

InterfacesApiService Disables a logical interface. Disables a logical interface in the running-configuration. Disabling an interface fires events including deferred events which are processed asynchronously. Disabling a logical interface is therefore considered an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.

func (*InterfacesApiService) DisablePhysicalInterface ¶

func (a *InterfacesApiService) DisablePhysicalInterface(ctx context.Context, ifpName string) (*http.Response, error)

InterfacesApiService Disables a physical interface. Disables a physical interface in the running-configuration. Disabling an interface fires events including deferred events which are processed asynchronously. Disabling a physical interface is therefore considered an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

func (*InterfacesApiService) EnableInterface ¶

func (a *InterfacesApiService) EnableInterface(ctx context.Context, ifName string) (*http.Response, error)

InterfacesApiService Enables a physical or a logical interface name. Enables the specified physical or a logical interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifName The physical or logical interface name.

func (*InterfacesApiService) EnableLogicalInterface ¶

func (a *InterfacesApiService) EnableLogicalInterface(ctx context.Context, iflName string) (*http.Response, error)

InterfacesApiService Enables a logical interface. Enables a logical interface in the running-configuration. Enables an interface fires events including deferred events which are processed asynchronously. Also certain services, like BGP peerings or IS-IS adjacencies for example, will be enabled after a logical interface has been enabled. Enabling a logical interface is therefore considered an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.

func (*InterfacesApiService) EnablePhysicalInterface ¶

func (a *InterfacesApiService) EnablePhysicalInterface(ctx context.Context, ifpName string) (*http.Response, error)

InterfacesApiService Enables a physical interface. Enables a physical interface in the running-configuration. Enables an interface fires events including deferred events which are processed asynchronously. Also certain services, like BGP peerings or IS-IS adjacencies for example, will be enabled after a physical interface has been enabled. Enabling a physical interface is therefore considered an asynchronous operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

func (*InterfacesApiService) GetInterface ¶

func (a *InterfacesApiService) GetInterface(ctx context.Context, ifpName string) (PhysicalInterfaceSummary, *http.Response, error)

InterfacesApiService Shows a physical interface and its logical interfaces. Shows a physical interface an its logical interfaces including their operational and administrative states, packet and byte counters, as well as configured speed, IP addresses and other settings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

@return PhysicalInterfaceSummary

func (*InterfacesApiService) GetInterfaces ¶

func (a *InterfacesApiService) GetInterfaces(ctx context.Context) ([]PhysicalInterfaceSummaryRef, *http.Response, error)

InterfacesApiService Lists all physical interfaces and their logical interfaces. Lists all physical interfaces and their logical interfaces including their administrative state, operational state, configured bandwidth, MAC address and neighbor information. Subscriber interfaces are not included in the response.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PhysicalInterfaceSummaryRef

func (*InterfacesApiService) GetLogicalInterface ¶

func (a *InterfacesApiService) GetLogicalInterface(ctx context.Context, iflName string) (LogicalInterface, *http.Response, error)

InterfacesApiService Shows a logical interface. Provides details of a logical interface including VLANs, IP addresses, administrative and operational states and counters.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.

@return LogicalInterface

func (*InterfacesApiService) GetPhysicalInterface ¶

func (a *InterfacesApiService) GetPhysicalInterface(ctx context.Context, ifpName string, localVarOptionals *InterfacesApiGetPhysicalInterfaceOpts) (PhysicalInterfaceDetail, *http.Response, error)

func (*InterfacesApiService) GetPhysicalInterfaces ¶

func (a *InterfacesApiService) GetPhysicalInterfaces(ctx context.Context, localVarOptionals *InterfacesApiGetPhysicalInterfacesOpts) ([]PhysicalInterface, *http.Response, error)

func (*InterfacesApiService) StartLogicalInterfaceTrafficCapture ¶

func (a *InterfacesApiService) StartLogicalInterfaceTrafficCapture(ctx context.Context, iflName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Starts logical interface traffic capturing. Starts capturing logical interface traffic to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

func (*InterfacesApiService) StartPhysicalInterfaceTrafficCapture ¶

func (a *InterfacesApiService) StartPhysicalInterfaceTrafficCapture(ctx context.Context, ifpName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Starts physical interface traffic capturing. Starts capturing physical interface traffic to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

func (*InterfacesApiService) StartTrafficCapture ¶

func (a *InterfacesApiService) StartTrafficCapture(ctx context.Context, ifName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Starts physical or logical interface traffic capturing. Starts capturing physical or logical interface traffic to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifName The physical or logical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

func (*InterfacesApiService) StopLogicalInterfaceTrafficCapture ¶

func (a *InterfacesApiService) StopLogicalInterfaceTrafficCapture(ctx context.Context, iflName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Stops logical interface traffic capturing. Stops traffic capturing of a logical interface to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param iflName The logical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

func (*InterfacesApiService) StopPhysicalInterfaceTrafficCapture ¶

func (a *InterfacesApiService) StopPhysicalInterfaceTrafficCapture(ctx context.Context, ifpName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Stops physical interface traffic capturing. Stops traffic capturing of a physical interface to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

func (*InterfacesApiService) StopTrafficCapture ¶

func (a *InterfacesApiService) StopTrafficCapture(ctx context.Context, ifName string, direction string, fileName string) (*http.Response, error)

InterfacesApiService Stops physical or logical interface traffic capturing. Stops capturing physical or logical interface traffic to a file.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifName The physical or logical interface name.
@param direction The direction of traffic to be captured.
@param fileName The capture file name.

type IsisInstance ¶

type IsisInstance struct {
	InstanceName string `json:"instance_name,omitempty"`
	// IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname string `json:"hostname,omitempty"`
	// IS-IS areas seen by this switch.
	Areas []string `json:"areas,omitempty"`
	// Status of the IS-IS overload flag. The value is true if the overload flag is set and the switch runs out of resources and cannot compute the SFP in time.
	Overload bool `json:"overload,omitempty"`
	// Segment routing settings.
	SegmentRouting *AllOfIsisInstanceSegmentRouting `json:"segment_routing,omitempty"`
	Neighbors      *IsisInstanceNeighborsSummary    `json:"neighbors,omitempty"`
	// Overview of IS-IS interfaces
	Interfaces []IsisInterface     `json:"interfaces,omitempty"`
	Timers     *IsisInstanceTimers `json:"timers,omitempty"`
}

IS-IS adjacency summary.

type IsisInstanceInterface ¶

type IsisInstanceInterface struct {
	// The IS-IS instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname string `json:"hostname,omitempty"`
	// The IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// IS-IS areas seen by this switch.
	Areas []string `json:"areas,omitempty"`
	// Status of the IS-IS overload flag. The value is true if the overload flag is set and the switch runs out of resources and might not compute the LSP in time.
	Overload   bool           `json:"overload,omitempty"`
	Interface_ *IsisInterface `json:"interface,omitempty"`
}

type IsisInstanceInterfaces ¶

type IsisInstanceInterfaces struct {
	// The IS-IS instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname string `json:"hostname,omitempty"`
	// The IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// IS-IS areas seen by this switch.
	Areas []string `json:"areas,omitempty"`
	// Status of the IS-IS overload flag. The value is true if the overload flag is set and the switch runs out of resources and might not compute the LSP in time.
	Overload bool `json:"overload,omitempty"`
	// Segment routing settings.
	SegmentRouting *AllOfIsisInstanceInterfacesSegmentRouting `json:"segment_routing,omitempty"`
	Interfaces     *IsisInstanceInterfacesInterfaces          `json:"interfaces,omitempty"`
}

type IsisInstanceInterfacesInterfaces ¶ added in v1.1.0

type IsisInstanceInterfacesInterfaces struct {
	// Number of active level 1 ISIS interfaces.
	Level1ActiveCount int `json:"level_1_active_count,omitempty"`
	// Number of active level 2 ISIS interfaces.
	Level2ActiveCount int `json:"level_2_active_count,omitempty"`
	// List of ISIS interfaces.
	Interfaces []IsisInterface `json:"interfaces,omitempty"`
}

type IsisInstanceNeighbor ¶

type IsisInstanceNeighbor struct {
	// The IS-IS instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname string `json:"hostname,omitempty"`
	// The IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// IS-IS areas seen by this switch.
	Areas []string `json:"areas,omitempty"`
	// Status of the IS-IS overload flag. The value is true if the overload flag is set and the switch runs out of resources and might not compute the LSP in time.
	Overload  bool           `json:"overload,omitempty"`
	Neighbors []IsisNeighbor `json:"neighbors,omitempty"`
}

IS-IS neighbors grouped by instance.

type IsisInstanceNeighbors ¶

type IsisInstanceNeighbors struct {
	// The IS-IS instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname string `json:"hostname,omitempty"`
	// The IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// IS-IS areas seen by this switch.
	Areas []string `json:"areas,omitempty"`
	// Status of the IS-IS overload flag. The value is true if the overload flag is set and the switch runs out of resources and might not compute the LSP in time.
	Overload  bool                          `json:"overload,omitempty"`
	Neighbors *IsisInstanceNeighborsSummary `json:"neighbors,omitempty"`
}

IS-IS neighbors grouped by instance.

type IsisInstanceNeighborsSummary ¶ added in v1.1.0

type IsisInstanceNeighborsSummary struct {
	// Total number of UP neighbors.
	UpCount int `json:"up_count,omitempty"`
	// Total count of flapped neighbors.
	FlapCount int `json:"flap_count,omitempty"`
	// Total numbers of level 1 neighbors.
	Level1Count int `json:"level_1_count,omitempty"`
	// Total numbers of level 2 neighbors.
	Level2Count int `json:"level_2_count,omitempty"`
	// List of neighbors.
	Neighbors []IsisNeighbor `json:"neighbors,omitempty"`
}

Overview of IS-IS neighbors.

type IsisInstanceRef ¶

type IsisInstanceRef struct {
	InstanceName string `json:"instance_name,omitempty"`
	// IS-IS overload flag value.
	Overload bool `json:"overload,omitempty"`
	// IS-IS system ID.
	SystemId string `json:"system_id,omitempty"`
	// The IS-IS host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS hostname.
	Hostname   string                     `json:"hostname,omitempty"`
	Neighbors  *IsisInstanceRefNeighbors  `json:"neighbors,omitempty"`
	Interfaces *IsisInstanceRefInterfaces `json:"interfaces,omitempty"`
	// List of IS-IS areas.
	Areas          []string `json:"areas,omitempty"`
	SegmentRouting *Srgb    `json:"segment_routing,omitempty"`
}

IS-IS instance summary.

type IsisInstanceRefInterfaces ¶

type IsisInstanceRefInterfaces struct {
	// Number of active L1 interfaces.
	Level1ActiveCount int `json:"level_1_active_count,omitempty"`
	// Number of active L2 interfaces.
	Level2ActiveCount int `json:"level_2_active_count,omitempty"`
}

Summary of IS-IS interfaces.

type IsisInstanceRefNeighbors ¶

type IsisInstanceRefNeighbors struct {
	// Number of UP neighbors.
	UpCount int `json:"up_count,omitempty"`
	// Neighbor flap count.
	FlapCount int `json:"flap_count,omitempty"`
	// Number of L1 neighbors.
	Level1Count int `json:"level_1_count,omitempty"`
	// Number of L2 neighbors.
	Level2Count int `json:"level_2_count,omitempty"`
}

Summary of IS-IS neighbors.

type IsisInstanceTimers ¶

type IsisInstanceTimers struct {
	// The hold time in seconds. A neighbor is considered down if no hello message is received from the neighbor before the hold time expires. The keep-alive interval for sending hello messages is derived from the hold time (keep-alive = hold / 3).
	HoldTime int `json:"hold_time,omitempty"`
	// The overload interval in seconds. A router in overload state resets the overload flag when the overload time is expired.
	OverloadTime int `json:"overload_time,omitempty"`
}

IS-IS timers.

type IsisInterface ¶

type IsisInterface struct {
	IflName string `json:"ifl_name,omitempty"`
	// The IS-IS interface state.
	IsisIflState string `json:"isis_ifl_state,omitempty"`
	// The IS-IS level.
	Level string `json:"level,omitempty"`
	// The IS-IS interface type.
	IsisIflType string `json:"isis_ifl_type,omitempty"`
	// Whether the interface is passive or not.
	Passive bool `json:"passive,omitempty"`
	// Segment routing settings of this interface.
	SegmentRouting *AllOfIsisInterfaceSegmentRouting `json:"segment_routing,omitempty"`
	Level1         *IsisInterfaceLevel               `json:"level_1,omitempty"`
	Level2         *IsisInterfaceLevel               `json:"level_2,omitempty"`
}

type IsisInterfaceLevel ¶ added in v1.1.0

type IsisInterfaceLevel struct {
	// The interface metric value.
	Metric     int                           `json:"metric,omitempty"`
	Statistics *IsisInterfaceLevelStatistics `json:"statistics,omitempty"`
}

Contains the metric and statistics of an ISIS level.

type IsisInterfaceLevelStatistics ¶ added in v1.1.0

type IsisInterfaceLevelStatistics struct {
	// Number of IS-IS neighbors.
	NeighborCount       int                                  `json:"neighbor_count,omitempty"`
	LspSuccessCount     int                                  `json:"lsp_success_count,omitempty"`
	LspFailcount        int                                  `json:"lsp_fail:count,omitempty"`
	LspPurgeCount       int                                  `json:"lsp_purge_count,omitempty"`
	CsnpSuccessCount    int                                  `json:"csnp_success_count,omitempty"`
	CsnpFailCount       int                                  `json:"csnp_fail_count,omitempty"`
	PsnpSuccessCount    int                                  `json:"psnp_success_count,omitempty"`
	PsnpFailCount       int                                  `json:"psnp_fail_count,omitempty"`
	CsnpAuthFailCount   int                                  `json:"csnp_auth_fail_count,omitempty"`
	PsnpAuthFailCount   int                                  `json:"psnp_auth_fail_count,omitempty"`
	P2pIihAuthFailCount int                                  `json:"p2p_iih_auth_fail_count,omitempty"`
	Ingress             *IsisInterfaceLevelStatisticsIngress `json:"ingress,omitempty"`
	Egress              *IsisInterfaceLevelStatisticsIngress `json:"egress,omitempty"`
}

type IsisInterfaceLevelStatisticsIngress ¶ added in v1.1.0

type IsisInterfaceLevelStatisticsIngress struct {
	LspCount    int `json:"lsp_count,omitempty"`
	CsnpCount   int `json:"csnp_count,omitempty"`
	PsnpCount   int `json:"psnp_count,omitempty"`
	P2pIihCount int `json:"p2p_iih_count,omitempty"`
}

type IsisInterfaceSriDs ¶ added in v1.1.0

type IsisInterfaceSriDs struct {
	// IPv4 SR index
	Ipv4Sid int `json:"ipv4_sid,omitempty"`
	// IPv6 SR index
	Ipv6Sid int `json:"ipv6_sid,omitempty"`
	// IPv4 SR anycast index
	Ipv4AnycastSid int `json:"ipv4_anycast_sid,omitempty"`
	// IPv6 SR anycast index
	Ipv6AnycastSid int `json:"ipv6_anycast_sid,omitempty"`
}

Segment routing indexes of an ISIS interface.

type IsisNeighbor ¶

type IsisNeighbor struct {
	// The IS-IS adjacency state.
	IsisAdjacencyState string `json:"isis_adjacency_state,omitempty"`
	// Last state transition time.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	// The IS-IS adjacency type.
	IsisAdjacencyType string `json:"isis_adjacency_type,omitempty"`
	// The IS-IS level(s) the adjacency belongs too.
	Level   string `json:"level,omitempty"`
	IflName string `json:"ifl_name,omitempty"`
	// Local IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// Local IPv6 address.
	Ipv6Address string                  `json:"ipv6_address,omitempty"`
	Neighbor    *IsisNeighborNeighbor   `json:"neighbor,omitempty"`
	Timers      *IsisNeighborTimers     `json:"timers,omitempty"`
	Statistics  *IsisNeighborStatistics `json:"statistics,omitempty"`
}

IS-IS neighbor details.

type IsisNeighborNeighbor ¶

type IsisNeighborNeighbor struct {
	// The IS-IS neighbor system ID.
	SystemId string `json:"system_id,omitempty"`
	// The ISIS neighbor host name.  The host_name attribute has been deprecated. Use the hostname attribute instead.
	HostName string `json:"host_name,omitempty"`
	// The IS-IS neighbor hostname.
	Hostname string `json:"hostname,omitempty"`
	// IS-IS neighbor IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// IS-IS neigbor IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
}

The IS-IS neighbor informations.

type IsisNeighborStatistics ¶

type IsisNeighborStatistics struct {
	// Total number of state transitions.
	StateTransitionCount int `json:"state_transition_count,omitempty"`
	// Information why the adjacency was down last time.
	LastDownReason string `json:"last_down_reason,omitempty"`
	// Since when this adjacency is UP.
	UpTime time.Time `json:"up_time,omitempty"`
	// Count of adjacency down due to level mismatch
	LevelMismatchErrorCount int `json:"level_mismatch_error_count,omitempty"`
	// Count of adjacency down due to area mismatch.
	AreaMismatchErrorCount int `json:"area_mismatch_error_count,omitempty"`
	// Count of adjacency down due to system ID mismatch.
	SystemIdErrorCount int `json:"system_id_error_count,omitempty"`
	// Count of adjacency down due to subnet mismatch.
	SubnetMismatchErrorCount int `json:"subnet_mismatch_error_count,omitempty"`
	// Count of adjacency down due to hold time expiry.
	HoldTimeoutErrorCount int `json:"hold_timeout_error_count,omitempty"`
	// Count of adjacency down due to neighbor down.
	NeighborDownErrorCount int `json:"neighbor_down_error_count,omitempty"`
	// Count of adjacency down due to interface down.
	IflDownErrorCount int `json:"ifl_down_error_count,omitempty"`
	// Count of adjacency down due to interaface config.
	IflConfigErrorCount int `json:"ifl_config_error_count,omitempty"`
	// Count of adjacency down due to reset from CLI.
	AdminResetCount int `json:"admin_reset_count,omitempty"`
	// Count of adjacency down due to area config.
	AreaConfigErrorCount int `json:"area_config_error_count,omitempty"`
	// Count of adjacency down due to other errors.
	OtherErrorCount int `json:"other_error_count,omitempty"`
	// Count of received hello messages.
	ReceivedKeepAliveCount int `json:"received_keep_alive_count,omitempty"`
}

Collection of IS-IS error counters maintained for this neighbor adjacency.

type IsisNeighborTimers ¶

type IsisNeighborTimers struct {
	// The hold time in seconds. The neighbor is considered down if no hello message is received before the hold time expires.
	HoldTime int `json:"hold_time,omitempty"`
	// The hold timer value in seconds, i.e. the time until the hold time expires.
	HoldTimer int `json:"hold_timer,omitempty"`
}

Summary of IS-IS timers.

type L2BSAApiService ¶

type L2BSAApiService service

func (*L2BSAApiService) GetL2BSAService ¶

func (a *L2BSAApiService) GetL2BSAService(ctx context.Context, ifpName string) ([]L2bsaServiceConfig, *http.Response, error)

L2BSAApiService Lists all L2BSA services on a physical interface. Lists all L2BSA services provisioned on the specified physical interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

@return []L2bsaServiceConfig

func (*L2BSAApiService) GetL2BSAServices ¶

func (a *L2BSAApiService) GetL2BSAServices(ctx context.Context) ([]L2bsaServiceConfig, *http.Response, error)

L2BSAApiService Lists all L2BSA services. Lists all L2BSA services provisioned on this switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []L2bsaServiceConfig

func (*L2BSAApiService) GetL2BSAServicesOfANP ¶

func (a *L2BSAApiService) GetL2BSAServicesOfANP(ctx context.Context, ifpName string, anp int) (L2bsaServiceConfig, *http.Response, error)

L2BSAApiService Shows a L2BSA service. Shows the L2BSA service on the given interface with the given ANP VLAN.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

@return L2bsaServiceConfig

func (*L2BSAApiService) ProcessL2BSAServiceBatch ¶ added in v1.1.0

func (a *L2BSAApiService) ProcessL2BSAServiceBatch(ctx context.Context, body L2bsaServiceConfigBatch) (*http.Response, error)

L2BSAApiService Runs L2BSA service configuration batch job. Stores or removes all L2BSA service configurations as specified in the batch instructions.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*L2BSAApiService) RemoveL2BSAServicesForANP ¶

func (a *L2BSAApiService) RemoveL2BSAServicesForANP(ctx context.Context, ifpName string, anp int) (*http.Response, error)

L2BSAApiService Removes a L2BSA service. Removes the L2BSA service configuration and terminates the associated subscriber session.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

func (*L2BSAApiService) StoreL2BSAService ¶

func (a *L2BSAApiService) StoreL2BSAService(ctx context.Context, body []L2bsaServiceConfig, ifpName string) ([]L2bsaServiceConfig, *http.Response, error)

L2BSAApiService Updates all L2BSA services on the given physical interface Updates all L2BSA services provisioned on the given physical interface of this switch by - adding new L2BSA services, - updating existing L2BSA services and - removing L2BSA services not included in the request entity. An empty request removes all L2BSA services from the given physical interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param ifpName The physical interface name.

@return []L2bsaServiceConfig

func (*L2BSAApiService) StoreL2BSAServices ¶

func (a *L2BSAApiService) StoreL2BSAServices(ctx context.Context, body []L2bsaServiceConfig) ([]L2bsaServiceConfig, *http.Response, error)

L2BSAApiService Updates all L2BSA services. Updates all L2BSA services provisioned on this switch by - adding new L2BSA services, - updating existing L2BSA services and - removing L2BSA services not included in the request entity. An empty request removes all L2BSA services from this switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return []L2bsaServiceConfig

func (*L2BSAApiService) StoreL2BSAServicesForANP ¶

func (a *L2BSAApiService) StoreL2BSAServicesForANP(ctx context.Context, body L2bsaServiceConfig, ifpName string, anp int) (*http.Response, error)

L2BSAApiService Stores a L2BSA service configuration. Stores the L2BSA service configuration.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

type L2bsaServiceConfig ¶

type L2bsaServiceConfig struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The ANP-VLAN ID.
	AnpVlan int `json:"anp_vlan,omitempty"`
	// The AAA profile name.
	AaaProfileName string                 `json:"aaa_profile_name,omitempty"`
	L2x            *L2xConfig             `json:"l2x,omitempty"`
	Qos            *L2bsaServiceConfigQos `json:"qos,omitempty"`
	AccessLineInfo *AccessLineInfo        `json:"access_line_info,omitempty"`
}

The ephemeral configuration of a L2BSA service. This configuration is lost if the switch reboots.

type L2bsaServiceConfigBatch ¶ added in v1.1.0

type L2bsaServiceConfigBatch struct {
	// The L2BSA service configurations to be removed.
	Remove []L2bsaServiceConfig `json:"remove,omitempty"`
	// The L2BSA service configurations to be stored.
	Store []L2bsaServiceConfig `json:"store,omitempty"`
}

Contains the L2BSA service configurations to be added and removed with this batch.

type L2bsaServiceConfigQos ¶

type L2bsaServiceConfigQos struct {
	// The QoS configuration profile name.
	QosProfileName string `json:"qos_profile_name,omitempty"`
	// The parent scheduler element of the scheduler-map assigned to the subscriber can be selected with this attribute. If not present, the scheduler-map will be directly bound to the corresponding IFP.
	ParentScheduler string `json:"parent_scheduler,omitempty"`
	// Dynamic QoS shaper string which contains a list of multiple shaper settings separated by semicolon.
	Shaper string `json:"shaper,omitempty"`
	// Dynamic QoS policer string which contains a list of multiple policer level settings separated by semicolon.
	Policer string `json:"policer,omitempty"`
	// Dynamic QoS queue string which contains a list of multiple queue sizes separated by semicolon.
	Queue string `json:"queue,omitempty"`
}

Dynamic QoS settings.

type L2xConfig ¶

type L2xConfig struct {
	// The L2X nexthop IPv4 or IPv6 address.
	IngressNexthop string `json:"ingress_nexthop,omitempty"`
	// The routing instance of the nexthop address.
	IngressLookupInstance string `json:"ingress_lookup_instance,omitempty"`
	// The L2X service MPLS label for ingress traffic (sent label).
	IngressServiceLabel int `json:"ingress_service_label,omitempty"`
	// The L2X service MPLS label for egress traffic (receive label).
	EgressServiceLabel int `json:"egress_service_label,omitempty"`
}

L2X settings.

type LDPApiService ¶ added in v1.1.0

type LDPApiService service

func (*LDPApiService) ClearLDPSession ¶ added in v1.1.0

func (a *LDPApiService) ClearLDPSession(ctx context.Context, instanceName string, peerIp string) (*http.Response, error)

LDPApiService Clears a LDP session Clears the LDP sessions and statistics for the LDP session with the given peer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The routing instance name.
@param peerIp The the peer IPv4 or IPv4 address.

func (*LDPApiService) ClearLDPSessions ¶ added in v1.1.0

func (a *LDPApiService) ClearLDPSessions(ctx context.Context, instanceName string) (*http.Response, error)

LDPApiService Clears all LDP sessions. Clears all LDP sessions associated with this instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The routing instance name.

func (*LDPApiService) GetLDPInstance ¶ added in v1.1.0

func (a *LDPApiService) GetLDPInstance(ctx context.Context, instanceName string) (LdpInstanceSessions, *http.Response, error)

LDPApiService Returns the LDP sessions and statistics. Returns the LDP sessions and statistics for the routing instance with the given name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The routing instance name.

@return LdpInstanceSessions

func (*LDPApiService) GetLDPInstances ¶ added in v1.1.0

func (a *LDPApiService) GetLDPInstances(ctx context.Context) (LdpInstanceRef, *http.Response, error)

LDPApiService Lists all instances running LDP. Returns all routing instances running LDP with some LDP statistics.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LdpInstanceRef

func (*LDPApiService) GetLDPSession ¶ added in v1.1.0

func (a *LDPApiService) GetLDPSession(ctx context.Context, instanceName string, peerIp string) (LdpInstanceSession, *http.Response, error)

LDPApiService Returns the LDP sessions details Returns the LDP sessions and statistics for the LDP session with the given peer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The routing instance name.
@param peerIp The the peer IPv4 or IPv4 address.

@return LdpInstanceSession

func (*LDPApiService) GetLDPSessions ¶ added in v1.1.0

func (a *LDPApiService) GetLDPSessions(ctx context.Context) (LdpInstanceSessions, *http.Response, error)

LDPApiService Lists LDP sessions Lists LDP sessions grouped by routing instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LdpInstanceSessions

type LLDPApiService ¶

type LLDPApiService service

func (*LLDPApiService) GetLLDPNeighbor ¶

func (a *LLDPApiService) GetLLDPNeighbor(ctx context.Context, ifpName string) (LldpGlobalNeighbor, *http.Response, error)

LLDPApiService Shows an LLDP neighbor Shows the LLDP neighbor for a given interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

@return LldpGlobalNeighbor

func (*LLDPApiService) GetLLDPNeighbors ¶

func (a *LLDPApiService) GetLLDPNeighbors(ctx context.Context) (LldpGlobalNeighbors, *http.Response, error)

LLDPApiService Lists all LLDP neighbors Lists all LLDP neighbors on all interfaces

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LldpGlobalNeighbors

type Lane ¶

type Lane struct {
	// The lane ID.
	LaneId int `json:"lane_id,omitempty"`
	// The optic temperature in degree celsius.
	TemperatureCelsius float64 `json:"temperature_celsius,omitempty"`
	// Voltage in volts.
	Voltage float64 `json:"voltage,omitempty"`
	Tx      *LaneTx `json:"tx,omitempty"`
	Rx      *LaneRx `json:"rx,omitempty"`
}

The optical lane information.

type LaneRx ¶

type LaneRx struct {
	// The status of the Loss-of-Signal (LoS) alert flag.
	LosAlert bool `json:"los_alert,omitempty"`
	// The laser power in milliwats.
	PowerMw float64 `json:"power_mw,omitempty"`
	// The laser power in dbm.
	PowerDbm float64 `json:"power_dbm,omitempty"`
	// The power high alarm threshold in milliwatts.
	PowerHighAlarmThresholdMw float64 `json:"power_high_alarm_threshold_mw,omitempty"`
	// The power high alarm threshold in dBm.
	PowerHighAlarmThresholdDbm float64 `json:"power_high_alarm_threshold_dbm,omitempty"`
	// The power warning threshold in milliwatts.
	PowerHighWarnThresholdMw float64 `json:"power_high_warn_threshold_mw,omitempty"`
	// The power high warning threshold in dBm.
	PowerHighWarnThresholdDbm float64 `json:"power_high_warn_threshold_dbm,omitempty"`
	// The power low alarm threshold in milliwatts.
	PowerLowAlarmThresholdMw float64 `json:"power_low_alarm_threshold_mw,omitempty"`
	// The power low alarm threshold in dBm.
	PowerLowAlarmThresholdDbm float64 `json:"power_low_alarm_threshold_dbm,omitempty"`
	// The power low warning threshold in milliwatts.
	PowerLowWarnThresholdMw float64 `json:"power_low_warn_threshold_mw,omitempty"`
	// The power low warning threshold in dBm.
	PowerLowWarnThresholdDbm float64 `json:"power_low_warn_threshold_dbm,omitempty"`
}

RX-related state.

type LaneTx ¶

type LaneTx struct {
	// The status of the Loss-of-Signal (LoS) alert flag.
	LosAlert bool `json:"los_alert,omitempty"`
	// The laser power in milliwatts.
	PowerMw float64 `json:"power_mw,omitempty"`
	// The laser power in dbm.
	PowerDbm float64 `json:"power_dbm,omitempty"`
	// The power high alarm threshold in milliwatts.
	PowerHighAlarmThresholdMw float64 `json:"power_high_alarm_threshold_mw,omitempty"`
	// The power high alarm threshold in dBm.
	PowerHighAlarmThresholdDbm float64 `json:"power_high_alarm_threshold_dbm,omitempty"`
	// The power warning threshold in milliwatts.
	PowerHighWarnThresholdMw float64 `json:"power_high_warn_threshold_mw,omitempty"`
	// The power high warning threshold in dBm.
	PowerHighWarnThresholdDbm float64 `json:"power_high_warn_threshold_dbm,omitempty"`
	// The power low alarm threshold in milliwatts.
	PowerLowAlarmThresholdMw float64 `json:"power_low_alarm_threshold_mw,omitempty"`
	// The power low alarm threshold in dBm.
	PowerLowAlarmThresholdDbm float64 `json:"power_low_alarm_threshold_dbm,omitempty"`
	// The power low warning threshold in milliwatts.
	PowerLowWarnThresholdMw float64 `json:"power_low_warn_threshold_mw,omitempty"`
	// The power low warning threshold in dBm.
	PowerLowWarnThresholdDbm float64 `json:"power_low_warn_threshold_dbm,omitempty"`
}

TX-related state.

type LdpCapabilities ¶ added in v1.1.0

type LdpCapabilities struct {
	// Graceful restart capabilty status.
	GracefulRestart bool                          `json:"graceful_restart,omitempty"`
	LoopDetection   *LdpCapabilitiesLoopDetection `json:"loop_detection,omitempty"`
}

Overview of LDP capabilities.

type LdpCapabilitiesLoopDetection ¶ added in v1.1.0

type LdpCapabilitiesLoopDetection struct {
	// Maximum number of hops accepted.
	MaxHopCount int `json:"max_hop_count,omitempty"`
	// Maximum vector length accepted.
	MaxVectorLength int `json:"max_vector_length,omitempty"`
}

Loop detection settings if loop detection is enabled.

type LdpInstanceRef ¶ added in v1.1.0

type LdpInstanceRef struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The LSR identifier.
	LsrId string `json:"lsr_id,omitempty"`
}

A routing instance with LDP enabled.

type LdpInstanceSession ¶ added in v1.1.0

type LdpInstanceSession struct {
	// The LSR lable-space identifier.
	LdpId string `json:"ldp_id,omitempty"`
	// The LSR identifier.
	LsrId                           string                           `json:"lsr_id,omitempty"`
	LdpState                        *LdpSessionState                 `json:"ldp_state,omitempty"`
	LdpLabelAdvertismentMode        *LdpLabelAdvertismentMode        `json:"ldp_label_advertisment_mode,omitempty"`
	LdpLabelDistributionControlMode *LdpLabelDistributionControlMode `json:"ldp_label_distribution_control_mode,omitempty"`
	LdpLabelRetentionMode           *LdpLabelRetentionMode           `json:"ldp_label_retention_mode,omitempty"`
	// LDP session flap count
	LdpSessionFlaps int `json:"ldp_session_flaps,omitempty"`
	// Last session state transition.
	LastStateTransition string   `json:"last_state_transition,omitempty"`
	LdpRole             *LdpRole `json:"ldp_role,omitempty"`
	IflName             string   `json:"ifl_name,omitempty"`
	// The local IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The local IPv6 address.
	Ipv6Address string                `json:"ipv6_address,omitempty"`
	Peer        *LdpSessionPeer       `json:"peer,omitempty"`
	Statistics  *LdpSessionStatistics `json:"statistics,omitempty"`
	Timers      *LdpSessionTimers     `json:"timers,omitempty"`
}

type LdpInstanceSessions ¶ added in v1.1.0

type LdpInstanceSessions struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The LSR identifier.
	LsrId        string                       `json:"lsr_id,omitempty"`
	Capabilities *LdpCapabilities             `json:"capabilities,omitempty"`
	Sessions     *LdpInstanceSessionsSessions `json:"sessions,omitempty"`
	Statistics   *LdpInstanceStatistics       `json:"statistics,omitempty"`
}

type LdpInstanceSessionsSessions ¶ added in v1.1.0

type LdpInstanceSessionsSessions struct {
	// Number of LDP sessions in NONEXISTENT state, i.e. session establishment has not started.
	NonExistent int `json:"non_existent,omitempty"`
	// Number of LDP sessions in OPENSENT state.
	OpensentCount int `json:"opensent_count,omitempty"`
	// Number of LDP sessions in OPENREC state.
	OpenrecCount int `json:"openrec_count,omitempty"`
	// Number of initialized LDP session.
	InitializedCount int `json:"initialized_count,omitempty"`
	// Number of operational LDP sessions.
	OperationalCount int `json:"operational_count,omitempty"`
	// List of LDP sessions.
	Sessions []LdpSession `json:"sessions,omitempty"`
}

LDP session

type LdpInstanceStatistics ¶ added in v1.1.0

type LdpInstanceStatistics struct {
	// Link adjacencies count.
	LinkAdjacenciesCount int `json:"link_adjacencies_count,omitempty"`
	// Targeted adjacencies count.
	TargetedAdjacenciesCount int `json:"targeted_adjacencies_count,omitempty"`
}

LDP statistics of a routing instance.

type LdpLabelAdvertismentMode ¶ added in v1.1.0

type LdpLabelAdvertismentMode string

LdpLabelAdvertismentMode : Label mapping control mode.

const (
	ORDERED_LdpLabelAdvertismentMode     LdpLabelAdvertismentMode = "ORDERED"
	INDEPENDENT_LdpLabelAdvertismentMode LdpLabelAdvertismentMode = "INDEPENDENT"
)

List of LDPLabelAdvertismentMode

type LdpLabelDistributionControlMode ¶ added in v1.1.0

type LdpLabelDistributionControlMode string

LdpLabelDistributionControlMode : Label mapping advertisment mode.

const (
	UNSOLICITED_LdpLabelDistributionControlMode LdpLabelDistributionControlMode = "DOWNSTREAM_UNSOLICITED"
	ON_DEMAND_LdpLabelDistributionControlMode   LdpLabelDistributionControlMode = "DOWNSTREAM_ON_DEMAND"
)

List of LDPLabelDistributionControlMode

type LdpLabelRetentionMode ¶ added in v1.1.0

type LdpLabelRetentionMode string

LdpLabelRetentionMode : Label retention mode.

const (
	CONSERVATIVE_LdpLabelRetentionMode LdpLabelRetentionMode = "CONSERVATIVE"
	LIBERAL_LdpLabelRetentionMode      LdpLabelRetentionMode = "LIBERAL"
)

List of LDPLabelRetentionMode

type LdpPeer ¶ added in v1.1.0

type LdpPeer struct {
	Ipv4Address string   `json:"ipv4_address,omitempty"`
	Ipv6Address string   `json:"ipv6_address,omitempty"`
	LdpRole     *LdpRole `json:"ldp_role,omitempty"`
}

type LdpRole ¶ added in v1.1.0

type LdpRole string

LdpRole : The role during TCP connection and LDP session establishment.

const (
	ACTIVE_LdpRole  LdpRole = "ACTIVE"
	PASSIVE_LdpRole LdpRole = "PASSIVE"
)

List of LDPRole

type LdpSession ¶ added in v1.1.0

type LdpSession struct {
	// The LSR lable-space identifier.
	LdpId string `json:"ldp_id,omitempty"`
	// The LSR identifier.
	LsrId                           string                           `json:"lsr_id,omitempty"`
	LdpState                        *LdpSessionState                 `json:"ldp_state,omitempty"`
	LdpLabelAdvertismentMode        *LdpLabelAdvertismentMode        `json:"ldp_label_advertisment_mode,omitempty"`
	LdpLabelDistributionControlMode *LdpLabelDistributionControlMode `json:"ldp_label_distribution_control_mode,omitempty"`
	LdpLabelRetentionMode           *LdpLabelRetentionMode           `json:"ldp_label_retention_mode,omitempty"`
	// LDP session flap count
	LdpSessionFlaps int `json:"ldp_session_flaps,omitempty"`
	// Last session state transition.
	LastStateTransition string   `json:"last_state_transition,omitempty"`
	LdpRole             *LdpRole `json:"ldp_role,omitempty"`
	IflName             string   `json:"ifl_name,omitempty"`
	// The local IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The local IPv6 address.
	Ipv6Address string                `json:"ipv6_address,omitempty"`
	Peer        *LdpSessionPeer       `json:"peer,omitempty"`
	Statistics  *LdpSessionStatistics `json:"statistics,omitempty"`
	Timers      *LdpSessionTimers     `json:"timers,omitempty"`
}

type LdpSessionPeer ¶ added in v1.1.0

type LdpSessionPeer struct {
	// The LSR identifier.
	LsrId   string   `json:"lsr_id,omitempty"`
	LdpRole *LdpRole `json:"ldp_role,omitempty"`
	// The peer IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The peer IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
}

The peer of this LSR session.

type LdpSessionState ¶ added in v1.1.0

type LdpSessionState string

LdpSessionState : Enumeration of LDP sessions states.

const (
	NON_EXISTENT_LdpSessionState LdpSessionState = "NON_EXISTENT"
	INITIALIZED_LdpSessionState  LdpSessionState = "INITIALIZED"
	OPENREC_LdpSessionState      LdpSessionState = "OPENREC"
	OPENSENT_LdpSessionState     LdpSessionState = "OPENSENT"
	OPERATIONAL_LdpSessionState  LdpSessionState = "OPERATIONAL"
)

List of LDPSessionState

type LdpSessionStatistics ¶ added in v1.1.0

type LdpSessionStatistics struct {
	Labels  *LdpSessionStatisticsLabels  `json:"labels,omitempty"`
	Session *LdpSessionStatisticsSession `json:"session,omitempty"`
}

LDP session statistics.

type LdpSessionStatisticsLabels ¶ added in v1.1.0

type LdpSessionStatisticsLabels struct {
	// Number of received FECs.
	FecsReceived int `json:"fecs_received,omitempty"`
	// Number of FECs sent.
	FecsSent int `json:"fecs_sent,omitempty"`
}

type LdpSessionStatisticsSession ¶ added in v1.1.0

type LdpSessionStatisticsSession struct {
	Ingress *LdpSessionStatisticsSessionIngress `json:"ingress,omitempty"`
	Egress  *LdpSessionStatisticsSessionEgress  `json:"egress,omitempty"`
}

type LdpSessionStatisticsSessionEgress ¶ added in v1.1.0

type LdpSessionStatisticsSessionEgress struct {
	// Number of sent init messages.
	Init int `json:"init,omitempty"`
	// Number of sent keep-alive messages.
	KeepAlive int `json:"keep_alive,omitempty"`
	// Number of sent notify messages.
	Notify int `json:"notify,omitempty"`
	// Number of sent label mapping messages.
	LabelMapping int `json:"label_mapping,omitempty"`
	// Number of sent label withdraw messages.
	LabelWithdraw int `json:"label_withdraw,omitempty"`
	// Number of sent label release messages.
	LabelRelease int `json:"label_release,omitempty"`
	// Number of sent address messages.
	LabelAddress int `json:"label_address,omitempty"`
	// Number of sent address withdraw messages.
	AddressWithdraw int `json:"address_withdraw,omitempty"`
}

type LdpSessionStatisticsSessionIngress ¶ added in v1.1.0

type LdpSessionStatisticsSessionIngress struct {
	// Number of received init messages.
	Init int `json:"init,omitempty"`
	// Number of received keep-alive messages.
	KeepAlive int `json:"keep_alive,omitempty"`
	// Number of received notify messages.
	Notify int `json:"notify,omitempty"`
	// Number of received label mapping messages.
	LabelMapping int `json:"label_mapping,omitempty"`
	// Number of received label withdraw messages.
	LabelWithdraw int `json:"label_withdraw,omitempty"`
	// Number of received label release messages.
	LabelRelease int `json:"label_release,omitempty"`
	// Number of received address messages.
	LabelAddress int `json:"label_address,omitempty"`
	// Number of received address withdraw messages.
	AddressWithdraw int `json:"address_withdraw,omitempty"`
}

type LdpSessionTimers ¶ added in v1.1.0

type LdpSessionTimers struct {
	// The negotiated hold time in seconds.
	HoldTime int `json:"hold_time,omitempty"`
	// The hold timer value in seconds.
	HoldTimer int `json:"hold_timer,omitempty"`
	// The negotiated keep-alive time in seconds.
	KeepAliveTime int `json:"keep_alive_time,omitempty"`
	// The keep-alive timer value in seconds.
	KeepAliveTimer int `json:"keep_alive_timer,omitempty"`
}

The timers associated with this LDP session.

type LinkAggregationGroup ¶ added in v1.1.0

type LinkAggregationGroup struct {
	// The LAG mode.
	Mode string `json:"mode,omitempty"`
	// The member interfaces.
	Members []LinkAggregationGroupMember `json:"members,omitempty"`
}

Link aggreation group (LAG) state.

type LinkAggregationGroupMember ¶ added in v1.1.0

type LinkAggregationGroupMember struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The operational state of the member interface.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative state of the member interface
	AdministrativeState string `json:"administrative_state,omitempty"`
	// The configured speed limit. The maximum speed can be read from the bandwidth attribute.
	Speed string `json:"speed,omitempty"`
	// The maximum bandwidth available.
	Bandwidth string `json:"bandwidth,omitempty"`
}

A member interface of a link aggregation group.

type LldpGlobalNeighbor ¶

type LldpGlobalNeighbor struct {
	// Global mode always.
	Mode string `json:"mode,omitempty"`
	// The local LLDP system name.
	SystemName string `json:"system_name,omitempty"`
	// An optional local LLDP system description.
	SystemDescription string `json:"system_description,omitempty"`
	// The local LLDP Tx interval.
	TransmitInterval int `json:"transmit_interval,omitempty"`
	// The local LLDP Tx holdtime.
	TransmitHoldime int           `json:"transmit_holdime,omitempty"`
	Neighbor        *LldpNeighbor `json:"neighbor,omitempty"`
}

A specific LLDP neighbor.

type LldpGlobalNeighbors ¶

type LldpGlobalNeighbors struct {
	// Global mode always.
	Mode string `json:"mode,omitempty"`
	// The local LLDP system name.
	SystemName string `json:"system_name,omitempty"`
	// An optional local LLDP system description.
	SystemDescription string `json:"system_description,omitempty"`
	// The local LLDP Tx interval.
	TransmitInterval int `json:"transmit_interval,omitempty"`
	// The local LLDP Tx holdtime.
	TransmitHoldime int            `json:"transmit_holdime,omitempty"`
	Neighbors       []LldpNeighbor `json:"neighbors,omitempty"`
}

LLDP neighbors

type LldpNeighbor ¶

type LldpNeighbor struct {
	// Local LLDP port ID.
	PortId string `json:"port_id,omitempty"`
	// The LLDP neighbor state.
	Status string `json:"status,omitempty"`
	// Time of last LLDP packet sent to neighbor.
	LastSent time.Time `json:"last_sent,omitempty"`
	// Time of last LLDP packet received from neighbor.
	LastReceived time.Time             `json:"last_received,omitempty"`
	Neighbor     *LldpNeighborNeighbor `json:"neighbor,omitempty"`
}

LLDP neighbor parameters.

type LldpNeighborNeighbor ¶

type LldpNeighborNeighbor struct {
	// Neighbor chassis ID in MAC address format.
	ChassisId string `json:"chassis_id,omitempty"`
	// Neighbor LLDP port ID.
	PortId string `json:"port_id,omitempty"`
	// Neighbor port description.
	PortDescription string `json:"port_description,omitempty"`
	// Neighbor system name.
	SystemName string `json:"system_name,omitempty"`
	// Time-to-Live received from neighbor.
	Ttl string `json:"ttl,omitempty"`
	// Timeout received from neighbor.
	Timeout string `json:"timeout,omitempty"`
}

Parameters of remote neighbor.

type LogicalInterface ¶

type LogicalInterface struct {
	IflName string `json:"ifl_name,omitempty"`
	IfpName string `json:"ifp_name,omitempty"`
	// The logical interface type.
	IflType string `json:"ifl_type,omitempty"`
	// The logical intreface alias.
	IflAlias     string `json:"ifl_alias,omitempty"`
	InstanceName string `json:"instance_name,omitempty"`
	// The MAC address on the logical interface.
	MacAddress string `json:"mac_address,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// The assigned IPv4 addresses.
	Ipv4Addresses []string `json:"ipv4_addresses,omitempty"`
	// Whether IPv4 is enabled or disabled on this logical interface.
	Ipv4State string `json:"ipv4_state,omitempty"`
	// IPv4 maximum transfer unit (MTU) size in bytes.
	Ipv4Mtu int `json:"ipv4_mtu,omitempty"`
	// The assigned IPv6 addresses.
	Ipv6Addresses []string `json:"ipv6_addresses,omitempty"`
	// Whether IPv6 is enabled or disabled on this logical interface.
	Ipv6State string `json:"ipv6_state,omitempty"`
	// IPv6 maximum transfer unit (MTU) size in bytes.
	Ipv6Mtu int `json:"ipv6_mtu,omitempty"`
	// MPLS maximum transfer unit (MTU) size in bytes.
	MplsMtu int `json:"mpls_mtu,omitempty"`
	// Whether MPLS is enabled or disabled on this logical interface.
	MplsState string `json:"mpls_state,omitempty"`
	// ISO maximum transfer unit (MTU) size.
	IsoMtu int `json:"iso_mtu,omitempty"`
	// Whether ISO is enabled or disabled on this logical interface.
	IsoState string `json:"iso_state,omitempty"`
	// The assigned VLANs.  The array is filled beginning with the outermost VLANS:  - The array is _empty_ or _omitted_ for untagged interfaces.  - The array contains the VLAN-ID for single tagged interfaces.  - The array contains the outer VLAN-ID followed by the inner VLAN-ID for double tagged interfaces.
	Vlans       []int                        `json:"vlans,omitempty"`
	IflCounters *LogicalInterfaceIflCounters `json:"ifl_counters,omitempty"`
}

A logical interface.

type LogicalInterfaceIflCounters ¶

type LogicalInterfaceIflCounters struct {
	Tx *LogicalInterfaceIflCountersTx `json:"tx,omitempty"`
	Rx *LogicalInterfaceIflCountersRx `json:"rx,omitempty"`
}

Logical interface counters.

type LogicalInterfaceIflCountersRx ¶

type LogicalInterfaceIflCountersRx struct {
	// Total number of packets received.
	PacketsReceived int `json:"packets_received,omitempty"`
	// Total number packets dropped.
	PacketsDropped int `json:"packets_dropped,omitempty"`
	// Total number of bytes received.
	BytesReceived int `json:"bytes_received,omitempty"`
	// Total number bytes dropped.
	BytesDropped int `json:"bytes_dropped,omitempty"`
}

Counters for received data.

type LogicalInterfaceIflCountersTx ¶

type LogicalInterfaceIflCountersTx struct {
	// Total number of packets sent.
	PacketsSent int `json:"packets_sent,omitempty"`
	// Total number packets dropped.
	PacketsDropped int `json:"packets_dropped,omitempty"`
	// Total number of bytes sent.
	BytesSent int `json:"bytes_sent,omitempty"`
	// Total number bytes dropped.
	BytesDropped int `json:"bytes_dropped,omitempty"`
}

Counters for transmitted data.

type McNextHops ¶ added in v1.1.0

type McNextHops struct {
	// Logical exit interface.
	ExitIfl string `json:"exit_ifl,omitempty"`
	// MAC addess of the next hop.
	NexthopMacAddress string `json:"nexthop_mac_address,omitempty"`
	// Type of the next hop.
	NexthopType string `json:"nexthop_type,omitempty"`
	// MLPS label operation.
	NexthopAction string `json:"nexthop_action,omitempty"`
	// MPLS labels for the next hop.
	MplsLabelStack []string `json:"mpls_label_stack,omitempty"`
	// Routing instance in which the NH is resolved.
	LookupInstance string `json:"lookup_instance,omitempty"`
	// Address family of the next hop.
	LookupAfi string `json:"lookup_afi,omitempty"`
	// Sub-address family of the next hop.
	LookupSafi string `json:"lookup_safi,omitempty"`
	// Next hop creation time.
	DateCreated time.Time `json:"date_created,omitempty"`
}

Next hop details.

type Mroutes ¶ added in v1.1.0

type Mroutes struct {
	// IPv4 group address with mask. Applicable to AFI 'ipv4' only
	MulticastGroup4 string `json:"multicast_group4,omitempty"`
	// IPv6 group address with mask. Applicable to AFI 'ipv6' only.
	MulticastGroup6 string `json:"multicast_group6,omitempty"`
	// IPv4 source address with mask. Applicable to AFI 'ipv4' only
	MulticastSource4 string `json:"multicast_source4,omitempty"`
	// IPv6 source address with mask. Applicable to AFI 'ipv6' only.
	MulticastSource6 string `json:"multicast_source6,omitempty"`
	// Soure of the route.
	Source string `json:"source,omitempty"`
	// Protocol preference.
	Preference int `json:"preference,omitempty"`
	// Multicast route type.
	MulticastRouteType string       `json:"multicast_route_type,omitempty"`
	NextHops           []McNextHops `json:"next_hops,omitempty"`
	// Route creation time.
	DateCreated time.Time `json:"date_created,omitempty"`
}

Multicast route table entries for a multicast group.

type NextHops ¶ added in v1.1.0

type NextHops struct {
	// IP address of the next hop.
	NexthopIpAddress string `json:"nexthop_ip_address,omitempty"`
	// MAC addess of the next hop.
	NexthopMacAddress string `json:"nexthop_mac_address,omitempty"`
	// Logical exit interface.
	ExitIfl string `json:"exit_ifl,omitempty"`
	// Type of the next hop.
	NexthopType string `json:"nexthop_type,omitempty"`
	// MLPS label operation.
	NexthopAction string `json:"nexthop_action,omitempty"`
	// MPLS labels for the next hop.
	MplsLabelStack []string `json:"mpls_label_stack,omitempty"`
	// Routing instance in which the NH is resolved.
	LookupInstance string `json:"lookup_instance,omitempty"`
	// Address family of the next hop.
	LookupAfi string `json:"lookup_afi,omitempty"`
	// Sub-address family of the next hop.
	LookupSafi string `json:"lookup_safi,omitempty"`
	// Next hop creation time.
	DateCreated time.Time `json:"date_created,omitempty"`
}

Next hop details.

type OSPFApiService ¶

type OSPFApiService service

func (*OSPFApiService) ClearOSPFNeighbor ¶

func (a *OSPFApiService) ClearOSPFNeighbor(ctx context.Context, instanceName string, areaId string, iflName string) (*http.Response, error)

OSPFApiService Clears an OSPF neighbor Resets an OSPF neighbor relationship, so that it needs to be re-established.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.
@param areaId The area in which the neighbor resides.
@param iflName The logical interface name.

func (*OSPFApiService) GetOSPFInstance ¶

func (a *OSPFApiService) GetOSPFInstance(ctx context.Context, instanceName string) (OspfInstanceDetails, *http.Response, error)

OSPFApiService Shows OSPF instance details Shows an OSPF instance including its interfaces and neighbors.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.

@return OspfInstanceDetails

func (*OSPFApiService) GetOSPFInstanceInterfaces ¶

func (a *OSPFApiService) GetOSPFInstanceInterfaces(ctx context.Context, instanceName string) (OspfInstanceInterfaces, *http.Response, error)

OSPFApiService Lists interfaces in an OSPF instance Shows an OSPF instance with its interfaces.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.

@return OspfInstanceInterfaces

func (*OSPFApiService) GetOSPFInstanceNeighbors ¶

func (a *OSPFApiService) GetOSPFInstanceNeighbors(ctx context.Context, instanceName string) (OspfInstanceNeighbors, *http.Response, error)

OSPFApiService Lists neighbors in an OSPF instance Shows an OSPF instance with its neighbors.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.

@return OspfInstanceNeighbors

func (*OSPFApiService) GetOSPFInstances ¶

func (a *OSPFApiService) GetOSPFInstances(ctx context.Context) ([]OspfInstanceSummary, *http.Response, error)

OSPFApiService Lists summary of all OSPF instances Lists all OSPF instances with some global administrative parameters and their areas.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OspfInstanceSummary

func (*OSPFApiService) GetOSPFInterface ¶

func (a *OSPFApiService) GetOSPFInterface(ctx context.Context, instanceName string, iflName string) (OspfInstanceInterface, *http.Response, error)

OSPFApiService Shows an OSPF interface Shows a single OSPF interface.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.
@param iflName The logical interface name.

@return OspfInstanceInterface

func (*OSPFApiService) GetOSPFInterfaces ¶

func (a *OSPFApiService) GetOSPFInterfaces(ctx context.Context) ([]OspfInstanceInterfaces, *http.Response, error)

OSPFApiService Lists all OSPF interfaces Lists all OSPF instances with their interfaces.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OspfInstanceInterfaces

func (*OSPFApiService) GetOSPFNeighbor ¶

func (a *OSPFApiService) GetOSPFNeighbor(ctx context.Context, instanceName string, iflName string) (OspfInstanceNeighbor, *http.Response, error)

OSPFApiService Shows an OSPF neighbor Shows a single OSPF neighbor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The OSPF instance name.
@param iflName The logical interface name.

@return OspfInstanceNeighbor

func (*OSPFApiService) GetOSPFNeighbors ¶

func (a *OSPFApiService) GetOSPFNeighbors(ctx context.Context) (OspfInstanceNeighbors, *http.Response, error)

OSPFApiService List all OSPF neighbors Lists all OSPF instances with their neighbors.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return OspfInstanceNeighbors

type Optic ¶

type Optic struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The optics serial number.
	SerialNumber string `json:"serial_number,omitempty"`
	// The optics part number.
	PartNumber string `json:"part_number,omitempty"`
	// The optics material number. The material number is a unique identifier for the materials management system.
	MaterialNumber string `json:"material_number,omitempty"`
	// The optics vendor name.
	VendorName string `json:"vendor_name,omitempty"`
	// The optics wave length.
	Wavelength float64 `json:"wavelength,omitempty"`
	// The optics type.
	OpticsType string `json:"optics_type,omitempty"`
	// The optics connector type.
	ConnectorType string `json:"connector_type,omitempty"`
	// The optics power class.
	PowerClass string `json:"power_class,omitempty"`
	// The optics power state class.
	PowerClassState string `json:"power_class_state,omitempty"`
	// The optics manufacturing date.
	DateManufactured string `json:"date_manufactured,omitempty"`
	Lanes            []Lane `json:"lanes,omitempty"`
}

type OpticModule ¶ added in v1.1.0

type OpticModule struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The optics serial number.
	SerialNumber string `json:"serial_number,omitempty"`
	// The optics part number.
	PartNumber string `json:"part_number,omitempty"`
	// The optics material number. The material number is a unique identifier for the materials management system.
	MaterialNumber string `json:"material_number,omitempty"`
	// The optics vendor name.
	VendorName string `json:"vendor_name,omitempty"`
	// The optics wave length.
	Wavelength float64 `json:"wavelength,omitempty"`
	// The optics type.
	OpticsType string `json:"optics_type,omitempty"`
	// The optics connector type.
	ConnectorType string `json:"connector_type,omitempty"`
	// The optics power class.
	PowerClass string `json:"power_class,omitempty"`
	// The optics power state class.
	PowerClassState string `json:"power_class_state,omitempty"`
	// The optics manufacturing date.
	DateManufactured string `json:"date_manufactured,omitempty"`
}

Optical module details.

type OpticsApiService ¶

type OpticsApiService service

func (*OpticsApiService) DisableLaser ¶ added in v1.1.0

func (a *OpticsApiService) DisableLaser(ctx context.Context, ifpName string) (*http.Response, error)

OpticsApiService Disable the laser. Disables the laser of the optic attached to the given physical port. Be aware that disabling the laser raises a LoS alert on the remote optic.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface (=port) name.

func (*OpticsApiService) EnableLaser ¶

func (a *OpticsApiService) EnableLaser(ctx context.Context, ifpName string) (*http.Response, error)

OpticsApiService Enables the laser. Enables the laser of the optic attached to the given port.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface (=port) name.

func (*OpticsApiService) GetOptic ¶

func (a *OpticsApiService) GetOptic(ctx context.Context, ifpName string) (Optic, *http.Response, error)

OpticsApiService Lists details of an attached optic. Provides a list of all single-form factor pluggable (SFP) optics attached to this switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface (=port) name.

@return Optic

func (*OpticsApiService) GetOptics ¶

func (a *OpticsApiService) GetOptics(ctx context.Context) ([]Optic, *http.Response, error)

OpticsApiService Lists all attached optics. Provides a list of all single-form factor pluggable (SFP) optics attached to this switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Optic

type OspfArea ¶

type OspfArea struct {
	// The OSPF area ID.
	AreaId string `json:"area_id,omitempty"`
	// The OSPF area type.
	AreaType string `json:"area_type,omitempty"`
}

OSPF area information.

type OspfInstanceDetails ¶

type OspfInstanceDetails struct {
	Flags *OspfInstanceGlobalFlags `json:"flags,omitempty"`
	// The address family of the OSPF instance.
	AddressFamily string `json:"address_family,omitempty"`
	// The OSPF flood interval.
	FloodInterval int `json:"flood_interval,omitempty"`
	// The default value of the OSPF interface metrics.
	DefaultMetric int `json:"default_metric,omitempty"`
	// OSPF opaque capability.
	OpaqueCapability bool `json:"opaque_capability,omitempty"`
	// OSPF segment routing capability.
	SegmentRouting bool `json:"segment_routing,omitempty"`
	// The segment routing global block start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// The size of the segment routing global block.
	SrgbRange int `json:"srgb_range,omitempty"`
}

type OspfInstanceGlobal ¶

type OspfInstanceGlobal struct {
	Flags *OspfInstanceGlobalFlags `json:"flags,omitempty"`
	// The address family of the OSPF instance.
	AddressFamily string `json:"address_family,omitempty"`
	// The OSPF flood interval.
	FloodInterval int `json:"flood_interval,omitempty"`
	// The default value of the OSPF interface metrics.
	DefaultMetric int `json:"default_metric,omitempty"`
	// OSPF opaque capability.
	OpaqueCapability bool `json:"opaque_capability,omitempty"`
	// OSPF segment routing capability.
	SegmentRouting bool `json:"segment_routing,omitempty"`
	// The segment routing global block start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// The size of the segment routing global block.
	SrgbRange int `json:"srgb_range,omitempty"`
}

type OspfInstanceGlobalFlags ¶

type OspfInstanceGlobalFlags struct {
	MplsTeShortcut   bool `json:"mpls_te_shortcut,omitempty"`
	NssaTranslateLsa bool `json:"nssa_translate_lsa,omitempty"`
	VirtualLink      bool `json:"virtual_link,omitempty"`
	Asbr             bool `json:"asbr,omitempty"`
	Abr              bool `json:"abr,omitempty"`
}

OSPF protocol flags.

type OspfInstanceInterface ¶

type OspfInstanceInterface struct {
	// The instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The OSPF router ID.
	RouterId   string         `json:"router_id,omitempty"`
	Interface_ *OspfInterface `json:"interface,omitempty"`
}

A specific OSPF interface.

type OspfInstanceInterfaces ¶

type OspfInstanceInterfaces struct {
	// The instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The OSPF router ID.
	RouterId   string          `json:"router_id,omitempty"`
	Interfaces []OspfInterface `json:"interfaces,omitempty"`
}

OSPF interfaces in an instance.

type OspfInstanceNeighbor ¶

type OspfInstanceNeighbor struct {
	// The instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The OSPF router ID.
	RouterId string        `json:"router_id,omitempty"`
	Neighbor *OspfNeighbor `json:"neighbor,omitempty"`
}

A specific OSPF neighbor.

type OspfInstanceNeighbors ¶

type OspfInstanceNeighbors struct {
	// The instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The OSPF router ID.
	RouterId  string         `json:"router_id,omitempty"`
	Neighbors []OspfNeighbor `json:"neighbors,omitempty"`
}

OSPF neighbors in an instance.

type OspfInstanceSummary ¶

type OspfInstanceSummary struct {
	Flags *OspfInstanceGlobalFlags `json:"flags,omitempty"`
	// The address family of the OSPF instance.
	AddressFamily string `json:"address_family,omitempty"`
	// The OSPF flood interval.
	FloodInterval int `json:"flood_interval,omitempty"`
	// The default value of the OSPF interface metrics.
	DefaultMetric int `json:"default_metric,omitempty"`
	// OSPF opaque capability.
	OpaqueCapability bool `json:"opaque_capability,omitempty"`
	// OSPF segment routing capability.
	SegmentRouting bool `json:"segment_routing,omitempty"`
	// The segment routing global block start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// The size of the segment routing global block.
	SrgbRange int `json:"srgb_range,omitempty"`
}

type OspfInterface ¶

type OspfInterface struct {
	IflName string `json:"ifl_name,omitempty"`
	// The OSPF area to which the interface belongs.
	AreaId string `json:"area_id,omitempty"`
	// The state of the OSPF interface.
	OspfIflState string `json:"ospf_ifl_state,omitempty"`
	// The OSPF interface type.
	OspfIflType string `json:"ospf_ifl_type,omitempty"`
	// Number of neighbors on the OSPF interface.
	FullNeighbors int `json:"full_neighbors,omitempty"`
	// The interface OSPF metric value.
	Metric int `json:"metric,omitempty"`
	// The IPv4 address of the interface in CIDR notation.
	Ipv4Prefix string `json:"ipv4_prefix,omitempty"`
	// The OSPF protocol MTU.
	Ipv4Mtu int `json:"ipv4_mtu,omitempty"`
	// OSPF priority on the interface.
	Priority int `json:"priority,omitempty"`
	// The designated router on the interface.
	DesignatedRouter string `json:"designated_router,omitempty"`
	// The backup designated router on the interface.
	BackupDesignatedRouter string `json:"backup_designated_router,omitempty"`
	// OSPF hello interval on the interface.
	HelloInterval int `json:"hello_interval,omitempty"`
	// OSPF dead interval on the interface.
	DeadInterval int `json:"dead_interval,omitempty"`
	// The segment routing index on the interface.
	SegmentRoutingIndex int `json:"segment_routing_index,omitempty"`
	// The authentication type on the interface.
	AuthenticationType string `json:"authentication_type,omitempty"`
}

type OspfNeighbor ¶

type OspfNeighbor struct {
	// The OSPF neighbor state.
	OspfNeighborState string `json:"ospf_neighbor_state,omitempty"`
	// The area in which the neighbor resides.
	AreaId  string `json:"area_id,omitempty"`
	IflName string `json:"ifl_name,omitempty"`
	// The local IPv4 address of the neighborship.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The designated router on the neighbor interface.
	DesignatedRouter string `json:"designated_router,omitempty"`
	// The backup designated router on the neighbor interface.
	BackupDesignatedRouter string                `json:"backup_designated_router,omitempty"`
	Neighbor               *OspfNeighborNeighbor `json:"neighbor,omitempty"`
}

OSPF neighbor details.

type OspfNeighborNeighbor ¶

type OspfNeighborNeighbor struct {
	// OSPF neighbor router ID.
	RouterId string `json:"router_id,omitempty"`
	// OSPF neighbor IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// Priority of the OSPF neighbor.
	Priority int `json:"priority,omitempty"`
	// Time the OSPF neighbor is in Up state.
	UpTime time.Time `json:"up_time,omitempty"`
	// OSPF dead interval of the neighbor.
	DeadInterval int `json:"dead_interval,omitempty"`
}

OSPF neighbor remote parameters.

type PIMApiService ¶

type PIMApiService service

func (*PIMApiService) GetPIMInstance ¶

func (a *PIMApiService) GetPIMInstance(ctx context.Context, instanceName string) (PimInstance, *http.Response, error)

PIMApiService Returns a PIM instance. Returns the PIM settings of the routing instance with the given instance name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The PIM instance name

@return PimInstance

func (*PIMApiService) GetPIMInstances ¶

func (a *PIMApiService) GetPIMInstances(ctx context.Context) ([]PimInstanceRef, *http.Response, error)

PIMApiService Lists all PIM instances. Lists all routing instances with PIM enabled.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PimInstanceRef

func (*PIMApiService) GetPIMInterface ¶

func (a *PIMApiService) GetPIMInterface(ctx context.Context, instanceName string, iflName string) (PimInterface, *http.Response, error)

PIMApiService Returns the PIM interface. Returns the PIM settings of the logical interface with the given name configured in the given instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The PIM instance name
@param iflName The logical interface name.

@return PimInterface

func (*PIMApiService) GetPIMInterfaces ¶

func (a *PIMApiService) GetPIMInterfaces(ctx context.Context) ([]PimInterfaces, *http.Response, error)

PIMApiService Lists all PIM interfaces. Lists all logical interfaces with PIM enabled grouped by routing instances.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PimInterfaces

func (*PIMApiService) GetPIMNeighbor ¶

func (a *PIMApiService) GetPIMNeighbor(ctx context.Context, instanceName string, neighborIp string) (PimNeighbor, *http.Response, error)

PIMApiService Returns the PIM neighbor. Returns the PIM neighbor information for the neighbor with the given IP address configured in the given instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceName The PIM instance name
@param neighborIp The neighbor IPv4 or IPv6 address.

@return PimNeighbor

func (*PIMApiService) GetPIMNeighbors ¶

func (a *PIMApiService) GetPIMNeighbors(ctx context.Context) ([]PimNeighbors, *http.Response, error)

PIMApiService Lists all PIM neighbors. Lists all PIM neighbors grouped by routing instances.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PimNeighbors

type PhysicalInterface ¶

type PhysicalInterface struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The physical interface alias.
	IfpAlias string `json:"ifp_alias,omitempty"`
	// The interface index (ifIndex)
	IfpIndex int `json:"ifp_index,omitempty"`
	// The physical interface type.
	IfpType string `json:"ifp_type,omitempty"`
	// The MAC address of the physical interface.
	MacAddress string `json:"mac_address,omitempty"`
	// The configured speed limit.  The maximum speed can be read from the bandwidth attribute.
	Speed string `json:"speed,omitempty"`
	// The maximum bandwidth available.
	Bandwidth string `json:"bandwidth,omitempty"`
	// The duplex mode.
	DuplexMode string `json:"duplex_mode,omitempty"`
	// The configured maximum transfer unit (MTU) size in bytes.
	MtuSize int `json:"mtu_size,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// Carrier transitions count.
	CarrierTransitions int `json:"carrier_transitions,omitempty"`
	// Timestamp since when this interface is UP.
	UpTime      time.Time                  `json:"up_time,omitempty"`
	Lag         *LinkAggregationGroup      `json:"lag,omitempty"`
	IfpCounters *PhysicalInterfaceCounters `json:"ifp_counters,omitempty"`
}

A physical interface.

type PhysicalInterfaceCounters ¶ added in v1.1.0

type PhysicalInterfaceCounters struct {
	Tx *PhysicalInterfaceCountersTx `json:"tx,omitempty"`
	Rx *PhysicalInterfaceCountersRx `json:"rx,omitempty"`
}

Physical interface statistics. Define a metric time-series for sampling counters to compute bit and packet rates. This counter values are only an indication whether data is transmitted or received. It can also be used to verify whether interface statistics have been reset after clearing the counters.

type PhysicalInterfaceCountersRx ¶ added in v1.1.0

type PhysicalInterfaceCountersRx struct {
	// Total number of received bytes.
	BytesReceived int `json:"bytes_received,omitempty"`
	// Total number of received packets.
	PacketsReceived int `json:"packets_received,omitempty"`
	// Total number of received. unicast packets.
	UnicastPacketsReceived int `json:"unicast_packets_received,omitempty"`
	// Total number of received multicast packets.
	MulticastPacketsReceived int `json:"multicast_packets_received,omitempty"`
	// Total count of received broadcast packets.
	BroadcastPacketsReceived int `json:"broadcast_packets_received,omitempty"`
	// Total count of dropped packets.
	PacketsDropped int `json:"packets_dropped,omitempty"`
}

Received data counters.

type PhysicalInterfaceCountersTx ¶ added in v1.1.0

type PhysicalInterfaceCountersTx struct {
	// Total number of transmitted bytes.
	BytesSent int `json:"bytes_sent,omitempty"`
	// Total number of transmitted packets.
	PacketsSent int `json:"packets_sent,omitempty"`
	// Total number of transmitted unicast packets.
	UnicastPacketsSent int `json:"unicast_packets_sent,omitempty"`
	// Total number of transmitted multicast packets.
	MulticastPacketsSent int `json:"multicast_packets_sent,omitempty"`
	// Total number of transmitted broadcast packets.
	BroadcastPacketsSent int `json:"broadcast_packets_sent,omitempty"`
	// Total number of dropped packets.
	PacketsDropped int `json:"packets_dropped,omitempty"`
}

Transmitted data counters.

type PhysicalInterfaceDetail ¶

type PhysicalInterfaceDetail struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The physical interface alias.
	IfpAlias string `json:"ifp_alias,omitempty"`
	// The interface index (ifIndex)
	IfpIndex int `json:"ifp_index,omitempty"`
	// The physical interface type.
	IfpType string `json:"ifp_type,omitempty"`
	// The MAC address of the physical interface.
	MacAddress string `json:"mac_address,omitempty"`
	// The configured speed limit.  The maximum speed can be read from the bandwidth attribute.
	Speed string `json:"speed,omitempty"`
	// The maximum bandwidth available.
	Bandwidth string `json:"bandwidth,omitempty"`
	// The duplex mode.
	DuplexMode string `json:"duplex_mode,omitempty"`
	// The configured maximum transfer unit (MTU) size in bytes.
	MtuSize int `json:"mtu_size,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// Carrier transitions count.
	CarrierTransitions int `json:"carrier_transitions,omitempty"`
	// Timestamp since when this interface is UP.
	UpTime      time.Time                  `json:"up_time,omitempty"`
	Optics      *Optic                     `json:"optics,omitempty"`
	Lag         *LinkAggregationGroup      `json:"lag,omitempty"`
	IfpCounters *PhysicalInterfaceCounters `json:"ifp_counters,omitempty"`
}

A physical interface with its optics and counters.

type PhysicalInterfaceSummary ¶

type PhysicalInterfaceSummary struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The physical interface alias.
	IfpAlias string `json:"ifp_alias,omitempty"`
	// The MAC address of the physical interface.
	MacAddress string `json:"mac_address,omitempty"`
	// The configured speed limit.  The maximum speed can be read from the bandwidth attribute.
	Speed string `json:"speed,omitempty"`
	// The maximum bandwidth available.
	Bandwidth string `json:"bandwidth,omitempty"`
	// The duplex mode.
	DuplexMode string `json:"duplex_mode,omitempty"`
	// The configured maximum transfer unit (MTU) size in bytes.
	MtuSize int `json:"mtu_size,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// Timestamp since when this interface is UP.
	UpTime time.Time `json:"up_time,omitempty"`
	// The logical interfaces defined on this physical interface.
	Ifls        []LogicalInterface         `json:"ifls,omitempty"`
	Lag         *LinkAggregationGroup      `json:"lag,omitempty"`
	IfpCounters *PhysicalInterfaceCounters `json:"ifp_counters,omitempty"`
}

A physical interface

type PhysicalInterfaceSummaryRef ¶

type PhysicalInterfaceSummaryRef struct {
	IfpName string `json:"ifp_name,omitempty"`
	// The physical interface alias.
	IfpAlias string `json:"ifp_alias,omitempty"`
	// The physical interface type.
	IfpType string `json:"ifp_type,omitempty"`
	// The MAC address of the physical interface.
	MacAddress string `json:"mac_address,omitempty"`
	// The configured speed limit.  The maximum speed can be read from the bandwidth attribute.
	Speed string `json:"speed,omitempty"`
	// The maximum bandwidth available.
	Bandwidth string `json:"bandwidth,omitempty"`
	// The duplex mode.
	DuplexMode string `json:"duplex_mode,omitempty"`
	// The configured maximum transfer unit (MTU) size in bytes.
	MtuSize int `json:"mtu_size,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// Timestamp since when this interface is UP.
	UpTime   time.Time                            `json:"up_time,omitempty"`
	Lag      *LinkAggregationGroup                `json:"lag,omitempty"`
	Logicals *PhysicalInterfaceSummaryRefLogicals `json:"logicals,omitempty"`
}

A physical interface summary. The physical interface summary includes the physical interface state and the logical interfaces defined on the physical interface with their respective operational state.

type PhysicalInterfaceSummaryRefLogicals ¶

type PhysicalInterfaceSummaryRefLogicals struct {
	IflName string `json:"ifl_name,omitempty"`
	// The interface alias.
	IflAlias string `json:"ifl_alias,omitempty"`
	// The interface type.
	IflType string `json:"ifl_type,omitempty"`
	// The administrative interface state.
	AdministrativeState string `json:"administrative_state,omitempty"`
	// The operational interface state.
	OperationalState string `json:"operational_state,omitempty"`
	// The assigned IPv4 addresses.
	Ipv4Addresses []string `json:"ipv4_addresses,omitempty"`
	// The assigned IPv6 addresses.
	Ipv6Addresses []string `json:"ipv6_addresses,omitempty"`
}

List of logical interfaces.

type PimDesignatedRouter ¶

type PimDesignatedRouter struct {
	// DR IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// DR IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The DR election priority of the selected designated router.
	Priority int `json:"priority,omitempty"`
}

Settings of the selected PIM designated router (DR).

type PimInstance ¶

type PimInstance struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The address-family identifier.
	Afi        string                 `json:"afi,omitempty"`
	Neighbors  []PimInstanceNeighbor  `json:"neighbors,omitempty"`
	Interfaces []PimInstanceInterface `json:"interfaces,omitempty"`
}

PIM instance state.

type PimInstanceInterface ¶

type PimInstanceInterface struct {
	IflName     string `json:"ifl_name,omitempty"`
	PimIflState string `json:"pim_ifl_state,omitempty"`
	// The primary IPv4 address of the PIM interface.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The primary IPv6 address of the PIM interface.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The PIM generation identifier.
	GenerationId int `json:"generation_id,omitempty"`
	// Total number of PIM neighbors on this interface.
	Neighbors int `json:"neighbors,omitempty"`
	// The priority of this interface in the designated router election.
	DesignatedRouterPriority int `json:"designated_router_priority,omitempty"`
	// Number of designated router elections being executed.
	DesignatedRouterElections int                               `json:"designated_router_elections,omitempty"`
	DesignatedRouter          *PimDesignatedRouter              `json:"designated_router,omitempty"`
	Statistics                *PimInstanceInterfaceStatistics   `json:"statistics,omitempty"`
	Timers                    *PimInstanceInterfaceTimers       `json:"timers,omitempty"`
	Capabilities              *PimInstanceInterfaceCapabilities `json:"capabilities,omitempty"`
}

PIM instance interface settings.

type PimInstanceInterfaceCapabilities ¶

type PimInstanceInterfaceCapabilities struct {
	// Flag that indicates whether Join suppression is disabled (true) or not (false)
	DisableJoinSuppression bool `json:"disable_join_suppression,omitempty"`
	// A flag that indicates whether the designated router (DR) election uses the DR priority.
	UseDesignatedRouterPriority bool `json:"use_designated_router_priority,omitempty"`
	// The effective prune delay interval in milliseconds.
	EffectivePruneDelayInterval int `json:"effective_prune_delay_interval,omitempty"`
	// The effective override interval in milliseconds.
	EffectiveOverrideInterval int `json:"effective_override_interval,omitempty"`
}

PIM interface capabilities

type PimInstanceInterfaceStatistics ¶

type PimInstanceInterfaceStatistics struct {
	Hello      *PimMessageStatistics `json:"hello,omitempty"`
	Assert     *PimMessageStatistics `json:"assert,omitempty"`
	Membership *PimMessageStatistics `json:"membership,omitempty"`
}

PIM interface statistics.

type PimInstanceInterfaceTimers ¶ added in v1.1.0

type PimInstanceInterfaceTimers struct {
	// The hello timer interval in seconds.
	HelloInterval int `json:"hello_interval,omitempty"`
	// The hold down interval in seconds.
	HoldDownInterval int `json:"hold_down_interval,omitempty"`
	// The Join/Prune interval in seconds.
	JoinPruneInterval int `json:"join_prune_interval,omitempty"`
	// The override interval in milliseconds.
	OverrideInterval int `json:"override_interval,omitempty"`
	// The prune delay interval in milliseconds.
	PruneDelayInterval int `json:"prune_delay_interval,omitempty"`
}

Configured timer values.

type PimInstanceNeighbor ¶

type PimInstanceNeighbor struct {
	PimNeighborState string `json:"pim_neighbor_state,omitempty"`
	// Last PIM neighbor state transition.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	IflName             string    `json:"ifl_name,omitempty"`
	PimIflState         string    `json:"pim_ifl_state,omitempty"`
	// The primary IPv4 address of the PIM interface.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The primary IPv6 address of the PIM interface.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The PIM interface generation ID.
	GenerationId int `json:"generation_id,omitempty"`
	// The priority of this interface in the designated router election.
	DesignatedRouterPriority int `json:"designated_router_priority,omitempty"`
	// DR elections count
	DesignatedRouterElections int                          `json:"designated_router_elections,omitempty"`
	DesignatedRouter          *PimDesignatedRouter         `json:"designated_router,omitempty"`
	Timers                    *PimInstanceNeighborTimers   `json:"timers,omitempty"`
	Neighbor                  *PimInstanceNeighborNeighbor `json:"neighbor,omitempty"`
}

PIM instance neighbor settings.

type PimInstanceNeighborNeighbor ¶

type PimInstanceNeighborNeighbor struct {
	// The PIM generation identifier.
	GenerationId int `json:"generation_id,omitempty"`
	// The neighbor IPv4 address.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The neighbor IPv6 address.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The neighbor's priority in the designated router elecetion process.
	DesignatedRouterPriority int `json:"designated_router_priority,omitempty"`
}

Discovered PIM neighbor settings.

type PimInstanceNeighborTimers ¶ added in v1.1.0

type PimInstanceNeighborTimers struct {
	// The configured hold down interval in seconds.
	HoldDownInterval int `json:"hold_down_interval,omitempty"`
	// The hold down timer value in seconds.
	HoldDownTimer int `json:"hold_down_timer,omitempty"`
}

Timer associated with this PIM neighbor.

type PimInstanceRef ¶

type PimInstanceRef struct {
	InstanceName string `json:"instance_name,omitempty"`
	// The address-family identifier.
	Afi string `json:"afi,omitempty"`
}

A reference to a PIM instances.

type PimInterface ¶

type PimInterface struct {
	IflName     string `json:"ifl_name,omitempty"`
	PimIflState string `json:"pim_ifl_state,omitempty"`
	// The primary IPv4 address of the PIM interface.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The primary IPv6 address of the PIM interface.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The PIM generation identifier.
	GenerationId int `json:"generation_id,omitempty"`
	// Total number of PIM neighbors on this interface.
	Neighbors int `json:"neighbors,omitempty"`
	// The priority of this interface in the designated router election.
	DesignatedRouterPriority int `json:"designated_router_priority,omitempty"`
	// Number of designated router elections being executed.
	DesignatedRouterElections int                               `json:"designated_router_elections,omitempty"`
	DesignatedRouter          *PimDesignatedRouter              `json:"designated_router,omitempty"`
	Statistics                *PimInstanceInterfaceStatistics   `json:"statistics,omitempty"`
	Timers                    *PimInstanceInterfaceTimers       `json:"timers,omitempty"`
	Capabilities              *PimInstanceInterfaceCapabilities `json:"capabilities,omitempty"`
}

PIM interface settings.

type PimInterfaces ¶

type PimInterfaces struct {
	InstanceName string                 `json:"instance_name,omitempty"`
	Interfaces   []PimInstanceInterface `json:"interfaces,omitempty"`
}

PIM interfaces grouped by instances.

type PimMessageStatistics ¶

type PimMessageStatistics struct {
	// Sent messages count.
	Sent int `json:"sent,omitempty"`
	// Received messages count.
	Received int `json:"received,omitempty"`
}

Counter of sent/received PIM messages.

type PimNeighbor ¶

type PimNeighbor struct {
	PimNeighborState string `json:"pim_neighbor_state,omitempty"`
	// Last PIM neighbor state transition.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	IflName             string    `json:"ifl_name,omitempty"`
	PimIflState         string    `json:"pim_ifl_state,omitempty"`
	// The primary IPv4 address of the PIM interface.
	Ipv4Address string `json:"ipv4_address,omitempty"`
	// The primary IPv6 address of the PIM interface.
	Ipv6Address string `json:"ipv6_address,omitempty"`
	// The PIM interface generation ID.
	GenerationId int `json:"generation_id,omitempty"`
	// The priority of this interface in the designated router election.
	DesignatedRouterPriority int `json:"designated_router_priority,omitempty"`
	// DR elections count
	DesignatedRouterElections int                          `json:"designated_router_elections,omitempty"`
	DesignatedRouter          *PimDesignatedRouter         `json:"designated_router,omitempty"`
	Timers                    *PimInstanceNeighborTimers   `json:"timers,omitempty"`
	Neighbor                  *PimInstanceNeighborNeighbor `json:"neighbor,omitempty"`
}

PIM neighbor settings.

type PimNeighbors ¶

type PimNeighbors struct {
	InstanceName string                `json:"instance_name,omitempty"`
	Neighbors    []PimInstanceNeighbor `json:"neighbors,omitempty"`
}

PIM neighbors grouped by instances.

type PingArguments ¶

type PingArguments struct {
	// The pinged destination IP address.
	DestinationIp string `json:"destination_ip,omitempty"`
	// The source IP address.
	SourceIp string `json:"source_ip,omitempty"`
	// The egress interface name.
	SourceIfl string `json:"source_ifl,omitempty"`
	// The routing instance name.
	InstanceName string `json:"instance_name,omitempty"`
	// The interval between two pings.
	Interval float32 `json:"interval,omitempty"`
	// The number of pings sent.
	Count int `json:"count,omitempty"`
	// The packet size in bytes.
	Size int `json:"size,omitempty"`
	// The IP TTL value.
	Ttl int `json:"ttl,omitempty"`
}

The arguments of the executed ping command.

type PingStatistics ¶

type PingStatistics struct {
	// Number of pings sent.
	Sent int `json:"sent,omitempty"`
	// Number of pings received.
	Received int `json:"received,omitempty"`
	// Number of pings lost.
	Lost int                `json:"lost,omitempty"`
	Rtt  *PingStatisticsRtt `json:"rtt,omitempty"`
}

Ping counters.

type PingStatisticsRtt ¶

type PingStatisticsRtt struct {
	// Minumum round-trip time.
	Min float64 `json:"min,omitempty"`
	// Average round-trip time.
	Avg float64 `json:"avg,omitempty"`
	// Maximum round-trip time.
	Max float64 `json:"max,omitempty"`
	// Round-trip time standard deviation.
	Stddev float64 `json:"stddev,omitempty"`
	// Total round-trip times to fire all pings.
	Total float64 `json:"total,omitempty"`
}

Round-trip time statistics.

type PingStatus ¶

type PingStatus struct {
	Ping       *PingArguments  `json:"ping,omitempty"`
	Statistics *PingStatistics `json:"statistics,omitempty"`
	// The command to run the ping from the CLI
	Command string `json:"command,omitempty"`
	// The ping command output. One item per line.
	Output []string `json:"output,omitempty"`
}

Describes the results of pinging a given destination IP.

type Psu ¶ added in v1.1.0

type Psu struct {
	// The name of the PSU.
	PsuName string `json:"psu_name,omitempty"`
	// The PSU model.
	Model string `json:"model,omitempty"`
	// The PSU serial number.
	SerialNumber string `json:"serial_number,omitempty"`
	// The presense and operational state of the PSU.
	Status []string `json:"status,omitempty"`
}

The power supply units.

type Routes ¶ added in v1.1.0

type Routes struct {
	// IPv4 address with mask. Applicable to AFI 'ipv4' only
	Prefix4 string `json:"prefix4,omitempty"`
	// IPv6 address with mask. Applicable to AFI 'ipv6' only.
	Prefix6 string `json:"prefix6,omitempty"`
	// MPLS label value. Applicable to AFI 'mpls' only.
	Label int `json:"label,omitempty"`
	// Route distingusher.
	RouteDistinguisher string `json:"route_distinguisher,omitempty"`
	// Soure of the route.
	Source string `json:"source,omitempty"`
	// Protocol preference.
	Preference int        `json:"preference,omitempty"`
	NextHops   []NextHops `json:"next_hops,omitempty"`
	// Route creation time.
	DateCreated time.Time `json:"date_created,omitempty"`
}

Route table entries for an IP prefix or MPLS label.

type RoutesApiGetInstanceMulticastRoutesOpts ¶ added in v1.1.0

type RoutesApiGetInstanceMulticastRoutesOpts struct {
	MulticastGroup4  optional.String
	MulticastGroup6  optional.String
	MulticastSource4 optional.String
	MulticastSource6 optional.String
}

type RoutesApiGetInstanceUnicastRoutesOpts ¶ added in v1.1.0

type RoutesApiGetInstanceUnicastRoutesOpts struct {
	Prefix4 optional.String
	Prefix6 optional.String
	Label   optional.String
}

type RoutesApiService ¶ added in v1.1.0

type RoutesApiService service

func (*RoutesApiService) GetInstanceMulticastRoutes ¶ added in v1.1.0

func (a *RoutesApiService) GetInstanceMulticastRoutes(ctx context.Context, instanceName string, afi string, safi string, localVarOptionals *RoutesApiGetInstanceMulticastRoutesOpts) (InstanceMulticastRoutes, *http.Response, error)

func (*RoutesApiService) GetInstanceUnicastRoutes ¶ added in v1.1.0

func (a *RoutesApiService) GetInstanceUnicastRoutes(ctx context.Context, instanceName string, afi string, safi string, localVarOptionals *RoutesApiGetInstanceUnicastRoutesOpts) (InstanceUnicastRoutes, *http.Response, error)

type Srgb ¶ added in v1.1.0

type Srgb struct {
	// SRGB start value.
	SrgbBase int `json:"srgb_base,omitempty"`
	// SRGB length.
	SrgbRange int `json:"srgb_range,omitempty"`
}

Segment routing global block settings.

type StreamsApiService ¶

type StreamsApiService service

func (*StreamsApiService) StreamPing ¶

func (a *StreamsApiService) StreamPing(ctx context.Context, localVarOptionals *StreamsApiStreamPingOpts) (string, *http.Response, error)

func (*StreamsApiService) StreamTraceroute ¶

func (a *StreamsApiService) StreamTraceroute(ctx context.Context, localVarOptionals *StreamsApiStreamTracerouteOpts) (string, *http.Response, error)

type StreamsApiStreamPingOpts ¶

type StreamsApiStreamPingOpts struct {
	DestinationIp   optional.String
	DestinationAaaa optional.String
	DestinationA    optional.String
	SourceIp        optional.String
	SourceIfl       optional.String
	InstanceName    optional.String
	Count           optional.Int
	Interval        optional.Float32
	Size            optional.Int
	Ttl             optional.Int
}

type StreamsApiStreamTracerouteOpts ¶

type StreamsApiStreamTracerouteOpts struct {
	DestinationIp   optional.String
	DestinationAaaa optional.String
	DestinationA    optional.String
	SourceIp        optional.String
	SourceIfl       optional.String
	InstanceName    optional.String
	MaxHops         optional.Int
	Size            optional.Int
	Interval        optional.Float32
}

type SubscriberAccessType ¶

type SubscriberAccessType string

SubscriberAccessType : The subscriber access type.

const (
	PP_PO_E_SubscriberAccessType SubscriberAccessType = "PPPoE"
	L2_TP_SubscriberAccessType   SubscriberAccessType = "L2TP"
	I_PO_E_SubscriberAccessType  SubscriberAccessType = "IPoE"
	L2_BSA_SubscriberAccessType  SubscriberAccessType = "L2BSA"
	TEST_SubscriberAccessType    SubscriberAccessType = "Test"
)

List of SubscriberAccessType

type SubscriberAccountingInfo ¶

type SubscriberAccountingInfo struct {
	// The accounting session ID.
	AccountingSessionId string `json:"accounting_session_id,omitempty"`
	// Timestamp when the accounting session has started.
	AccountingStartTime time.Time `json:"accounting_start_time,omitempty"`
	// Timestamp when the accounting session has stopped.
	AccountingStopTime time.Time `json:"accounting_stop_time,omitempty"`
}

type SubscriberAdjustedAccounting ¶

type SubscriberAdjustedAccounting struct {
	// A flag to indicate whether accounting is in progress (true) or  the final counter values have been read from the hardware (false).
	AccountingActive bool `json:"accounting_active,omitempty"`
	// Number of packets received in this session.
	SessionIngressPackets int `json:"session_ingress_packets,omitempty"`
	// Number of bytes received in this session.
	SessionIngressBytes int `json:"session_ingress_bytes,omitempty"`
	// Number of packets sent in this session.
	SessionEgressPackets int `json:"session_egress_packets,omitempty"`
	// Number of bytes sent in this session.
	SessionEgressBytes int `json:"session_egress_bytes,omitempty"`
	// Number of packets received on the subscriber interface.
	IflIngressPackets int `json:"ifl_ingress_packets,omitempty"`
	// Number of bytes received on the subscriber interface.
	IflIngressBytes int `json:"ifl_ingress_bytes,omitempty"`
	// Number of packets sent over  the subscriber interface.
	IflEgressPackets int `json:"ifl_egress_packets,omitempty"`
	// Number of bytes sent over  the subscriber interface.
	IflEgressBytes int `json:"ifl_egress_bytes,omitempty"`
	// Number of sent packets in class 0.
	Class0EgressPackets int `json:"class_0_egress_packets,omitempty"`
	// Number of sent bytes in class 0.
	Class0EgressBytes int `json:"class_0_egress_bytes,omitempty"`
	// Number of sent packets in class 1.
	Class1EgressPackets int `json:"class_1_egress_packets,omitempty"`
	// Number of sent bytes in class 1.
	Class1EgressBytes int `json:"class_1_egress_bytes,omitempty"`
	// Number of sent packets in class 2.
	Class2EgressPackets int `json:"class_2_egress_packets,omitempty"`
	// Number of sent bytes in class 2.
	Class2EgressBytes int `json:"class_2_egress_bytes,omitempty"`
	// Number of sent packets in class 3.
	Class3EgressPackets int `json:"class_3_egress_packets,omitempty"`
	// Number of sent bytes in class 3.
	Class3EgressBytes int `json:"class_3_egress_bytes,omitempty"`
	// Number of sent packets in class 4.
	Class4EgressPackets int `json:"class_4_egress_packets,omitempty"`
	// Number of sent bytes in class 4.
	Class4EgressBytes int `json:"class_4_egress_bytes,omitempty"`
	// Number of sent packets in class 5.
	Class5EgressPackets int `json:"class_5_egress_packets,omitempty"`
	// Number of sent bytes in class 5.
	Class5EgressBytes int `json:"class_5_egress_bytes,omitempty"`
	// Number of sent packets in class 6.
	Class6EgressPackets int `json:"class_6_egress_packets,omitempty"`
	// Number of sent bytes in class 6.
	Class6EgressBytes int `json:"class_6_egress_bytes,omitempty"`
	// Number of sent packets in class 7.
	Class7EgressPackets int `json:"class_7_egress_packets,omitempty"`
	// Number of sent bytes in class 7.
	Class7EgressBytes int `json:"class_7_egress_bytes,omitempty"`
	// Number of received packets in policer level 1.
	PolicerL1IngressPackets int `json:"policer_l1_ingress_packets,omitempty"`
	// Number of received bytes in policer level 1.
	PolicerL1IngressBytes int `json:"policer_l1_ingress_bytes,omitempty"`
	// Number of received packets in policer level 2.
	PolicerL2IngressPackets int `json:"policer_l2_ingress_packets,omitempty"`
	// Number of received bytes in policer level 2.
	PolicerL2IngressBytes int `json:"policer_l2_ingress_bytes,omitempty"`
	// Number of received packets in policer level 3.
	PolicerL3IngressPackets int `json:"policer_l3_ingress_packets,omitempty"`
	// Number of received bytes in policer level 3.
	PolicerL3IngressBytes int `json:"policer_l3_ingress_bytes,omitempty"`
	// Number of received packets in policer level 4.
	PolicerL4IngressPackets int `json:"policer_l4_ingress_packets,omitempty"`
	// Number of received bytes in policer level 4.
	PolicerL4IngressBytes int `json:"policer_l4_ingress_bytes,omitempty"`
}

Current adjusted accounting values.

type SubscriberApiClearSubscriberOpts ¶

type SubscriberApiClearSubscriberOpts struct {
	Force optional.Bool
}

type SubscriberApiClearSubscribersOpts ¶

type SubscriberApiClearSubscribersOpts struct {
	IfpName                   optional.String
	IflName                   optional.String
	OuterVlan                 optional.Int
	AnpVlan                   optional.Int
	InnerVlan                 optional.Int
	SubscriberId              optional.Interface
	AccountingSessionId       optional.String
	SubscriberUserName        optional.String
	SubscriberUserNameMatches optional.String
	AgentRemoteId             optional.String
	AgentRemoteIdMatches      optional.String
	AgentCircuitId            optional.String
	AgentCircuitIdMatches     optional.String
	AccessType                optional.Interface
}

type SubscriberApiGetSubscriberHistoryOpts ¶

type SubscriberApiGetSubscriberHistoryOpts struct {
	SubscriberUserName        optional.String
	SubscriberUserNameMatches optional.String
	IfpName                   optional.String
	InnerVlan                 optional.Int
	OuterVlan                 optional.Int
	SubscriberId              optional.Float64
	AccessType                optional.String
	AccessRemoteId            optional.String
	AccessRemoteIdMatches     optional.String
	AccessCircuitId           optional.String
	AccessCircuitIdMatches    optional.String
}

type SubscriberApiGetSubscribersOpts ¶

type SubscriberApiGetSubscribersOpts struct {
	IfpName                   optional.String
	IflName                   optional.String
	OuterVlan                 optional.Int
	AnpVlan                   optional.Int
	InnerVlan                 optional.Int
	SubscriberId              optional.Interface
	AccountingSessionId       optional.String
	SubscriberUserName        optional.String
	SubscriberUserNameMatches optional.String
	AgentRemoteId             optional.String
	AgentRemoteIdMatches      optional.String
	AgentCircuitId            optional.String
	AgentCircuitIdMatches     optional.String
	AccessType                optional.Interface
	Limit                     optional.Int
	Cursor                    optional.String
}

type SubscriberApiService ¶

type SubscriberApiService service

func (*SubscriberApiService) AddTestSubscribers ¶

func (a *SubscriberApiService) AddTestSubscribers(ctx context.Context, body []TestAaaObject) (*http.Response, error)

SubscriberApiService Adds test subscribers. Injects test subscribers into the Test AAA request table.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body List of subscriber attribute objects.

func (*SubscriberApiService) ClearL2BSASubscriber ¶

func (a *SubscriberApiService) ClearL2BSASubscriber(ctx context.Context, ifpName string, anp int) (*http.Response, error)

SubscriberApiService Terminates the L2BSA subscriber session. Trigger the asynchronous subscribers termination.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

func (*SubscriberApiService) ClearSubscriber ¶

func (a *SubscriberApiService) ClearSubscriber(ctx context.Context, subscriberId int, localVarOptionals *SubscriberApiClearSubscriberOpts) (*http.Response, error)

func (*SubscriberApiService) ClearSubscribers ¶

func (a *SubscriberApiService) ClearSubscribers(ctx context.Context, localVarOptionals *SubscriberApiClearSubscribersOpts) (*http.Response, error)

func (*SubscriberApiService) DisableLawfulInterception ¶

func (a *SubscriberApiService) DisableLawfulInterception(ctx context.Context, subscriberId int, id int) (*http.Response, error)

SubscriberApiService Disables lawful interception for the specified subscriber. Disables lawful interception (LI) for the specified subscriber with the specified mediation device, direction and LI identifier.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.
@param id The LI request ID.

func (*SubscriberApiService) EnableLawfulInterception ¶

func (a *SubscriberApiService) EnableLawfulInterception(ctx context.Context, subscriberId int, id int, direction string, medIp string, medPort int, medInstance string) (*http.Response, error)

SubscriberApiService Enables lawful interception for the specified subscriber. Enables lawful interception (LI) for the specified subscriber with the specified mediation device, direction and LI identifier.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.
@param id The LI request ID.
@param direction The direction of traffic being intercepted.
@param medIp Mediation device IP address.
@param medPort Meditation device port.
@param medInstance Meditation device routing instance name.

func (*SubscriberApiService) GetAccessLineInfo ¶

func (a *SubscriberApiService) GetAccessLineInfo(ctx context.Context, subscriberId int) (AccessLineInfo, *http.Response, error)

SubscriberApiService Returns access line information. Returns the access line information for the given subscriber.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.

@return AccessLineInfo

func (*SubscriberApiService) GetAjdustedAccountingValues ¶

func (a *SubscriberApiService) GetAjdustedAccountingValues(ctx context.Context, subscriberId int) (SubscriberAdjustedAccounting, *http.Response, error)

SubscriberApiService Returns adjusted accounting counter values. Computes the adjusted accounting counter values for a given subscriber.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.

@return SubscriberAdjustedAccounting

func (*SubscriberApiService) GetIfpSubscriberSessionStatistics ¶ added in v1.1.0

func (a *SubscriberApiService) GetIfpSubscriberSessionStatistics(ctx context.Context, ifpName string) (IfpSubscriberSessionStatistics, *http.Response, error)

SubscriberApiService Returns the subscriber session statistics for a physical interface. Returns the number of subscriber sessions grouped by access type (IPoE, PPPoE, L2TP, L2BSA and test), the session state (setup, established, terminating) as well as the total session count grouped by the session state.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.

@return IfpSubscriberSessionStatistics

func (*SubscriberApiService) GetL2BSASubscriber ¶

func (a *SubscriberApiService) GetL2BSASubscriber(ctx context.Context, ifpName string, anp int) (SubscriberSession, *http.Response, error)

SubscriberApiService Shows L2BSA subscriber session details. Provides L2BSA subscriber details including accounting information, logical interface information, VLAN information, physical interface information, and access line information. This commands returns the same output as `GET /subscribers/{subscriber_id}` just with a different key using interface name and ANP VLAN ID instead of subscriber ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

@return SubscriberSession

func (*SubscriberApiService) GetL2BSASubscriberAdjustedAccountingValues ¶

func (a *SubscriberApiService) GetL2BSASubscriberAdjustedAccountingValues(ctx context.Context, ifpName string, anp int) (SubscriberAdjustedAccounting, *http.Response, error)

SubscriberApiService Get adjusted accounting counter values. Computes the adjusted accounting counter values for a given L2BSA subscriber. This commands returns the same output as `GET /subscribers/{subscriber_id}/adjusted-accounting` just with a different key using interface name and ANP VLAN ID instead of subscriber ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ifpName The physical interface name.
@param anp The ANP VLAN ID.

@return SubscriberAdjustedAccounting

func (*SubscriberApiService) GetSubscriber ¶

func (a *SubscriberApiService) GetSubscriber(ctx context.Context, subscriberId int) (SubscriberSession, *http.Response, error)

SubscriberApiService Shows subscriber session details. Provides subscriber session details including accounting information, logical interface information, VLAN information, L2TP or PPPoE session information, physical interface information, and access line information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.

@return SubscriberSession

func (*SubscriberApiService) GetSubscriberHistory ¶

func (a *SubscriberApiService) GetSubscriberHistory(ctx context.Context, localVarOptionals *SubscriberApiGetSubscriberHistoryOpts) ([]SubscriberHistory, *http.Response, error)

func (*SubscriberApiService) GetSubscriberSessionStatistics ¶ added in v1.1.0

func (a *SubscriberApiService) GetSubscriberSessionStatistics(ctx context.Context) (SubscriberSessionStatistics, *http.Response, error)

SubscriberApiService Returns the subscriber session summary statistics. Returns the number of subscriber sessions grouped by the access type (IPoE, PPPoE, L2TP, L2BSA and test), the session state (setup, established, terminating) and the physical interface as well as aggregated counts. The aggregated counts include the total number of sessions per physical interface and state as well as the number of sessions per access type and state, and the total session count per state for the entire switch.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SubscriberSessionStatistics

func (*SubscriberApiService) GetSubscribers ¶

func (a *SubscriberApiService) GetSubscribers(ctx context.Context, localVarOptionals *SubscriberApiGetSubscribersOpts) ([]SubscriberSessionRef, *http.Response, error)

func (*SubscriberApiService) GetTestSubscribers ¶

func (a *SubscriberApiService) GetTestSubscribers(ctx context.Context) ([]TestAaaObject, *http.Response, error)

SubscriberApiService Lists all test subscribers. Reads all test subscriber objects from the Test AAA request table.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []TestAaaObject

func (*SubscriberApiService) RemoveTestSubscriber ¶

func (a *SubscriberApiService) RemoveTestSubscriber(ctx context.Context, subscriberId int) (*http.Response, error)

SubscriberApiService Deletes a test subscriber. Removes a test subscriber from the Test AAA request table.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriberId The subscriber ID.

func (*SubscriberApiService) StoreTestSubscriber ¶

func (a *SubscriberApiService) StoreTestSubscriber(ctx context.Context, body TestAaaObject, subscriberId int) (*http.Response, error)

SubscriberApiService Adds or updates a test subscriber. Injects a test subscriber into the Test AAA request table.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Subscriber attributes.
@param subscriberId The subscriber ID.

func (*SubscriberApiService) StoreTestSubscribers ¶

func (a *SubscriberApiService) StoreTestSubscribers(ctx context.Context, body []TestAaaObject) (*http.Response, error)

SubscriberApiService Replaces all test subscribers. Flushes the Test AAA request table and adds the test subscribers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body List of subscriber attribute objects.

type SubscriberHistory ¶

type SubscriberHistory struct {
	SubscriberId int `json:"subscriber_id,omitempty"`
	// String subscriber_id representation for I-JSON compliance.
	SubscriberIdStr string `json:"subscriber_id_str,omitempty"`
	// The subscriber's user name.
	SubscriberUserName string `json:"subscriber_user_name,omitempty"`
	// Reason why the subscriber session got terminated.
	SubscriberTerminationReason string `json:"subscriber_termination_reason,omitempty"`
	// The accounting session ID.
	AccountingSessionId string `json:"accounting_session_id,omitempty"`
	IfpName             string `json:"ifp_name,omitempty"`
	// The inner VLAN (C-tag) associated with the subscriber.
	InnerVlan int `json:"inner_vlan,omitempty"`
	// The outer VLAN (S-tag) associated with the subscriber.
	OuterVlan int `json:"outer_vlan,omitempty"`
	// The client MAC address.
	ClientMac  string                `json:"client_mac,omitempty"`
	AccessType *SubscriberAccessType `json:"access_type,omitempty"`
	// The Agent-Remote-ID (ARI).
	AgentRemoteId string `json:"agent_remote_id,omitempty"`
	// The Agent-Circuit-ID (ACI).
	AgentCircuitId string `json:"agent_circuit_id,omitempty"`
}

Provides details about a terminated subscriber session.

type SubscriberQosPolicer ¶

type SubscriberQosPolicer struct {
	// The committed information rate (CIR) in kbps.
	CirKbps int `json:"cir_kbps,omitempty"`
	// The comitted burst size (CBS) in kbps.
	CbsKbps int `json:"cbs_kbps,omitempty"`
	// The peak information rate (PIR) in kbps.
	PirKbps int `json:"pir_kbps,omitempty"`
	// The peak burst size (PBS) in kbps.
	PbsKbps int `json:"pbs_kbps,omitempty"`
}

Subscriber QoS policer settings.

type SubscriberQosProfile ¶

type SubscriberQosProfile struct {
	// The QoS profile name.
	QosProfileName string                        `json:"qos_profile_name,omitempty"`
	Policers       *SubscriberQosProfilePolicers `json:"policers,omitempty"`
	// The applied shapers.
	Shapers map[string]SubscriberQosShaper `json:"shapers,omitempty"`
}

The subscriber QoS settings.

type SubscriberQosProfilePolicers ¶

type SubscriberQosProfilePolicers struct {
	Level1 *SubscriberQosPolicer `json:"level_1,omitempty"`
	Level2 *SubscriberQosPolicer `json:"level_2,omitempty"`
	Level3 *SubscriberQosPolicer `json:"level_3,omitempty"`
	Level4 *SubscriberQosPolicer `json:"level_4,omitempty"`
}

The applied policers ordered by their respective level.

type SubscriberQosShaper ¶

type SubscriberQosShaper struct {
	// The low rate in kbps.
	RateLowKbps int `json:"rate_low_kbps,omitempty"`
	// The high rate in kbps.
	RateHighKbps int `json:"rate_high_kbps,omitempty"`
}

Subscriber QoS shaper settings

type SubscriberSession ¶

type SubscriberSession struct {
	// The current subscriber FSM state.
	SubscriberState string `json:"subscriber_state,omitempty"`
	// The timestamp of the last FSM state transition.
	LastStateTransition time.Time `json:"last_state_transition,omitempty"`
	// Reason why the subscriber session got terminated.
	SubscriberTerminationReason string `json:"subscriber_termination_reason,omitempty"`
	SubscriberId                int    `json:"subscriber_id,omitempty"`
	// String subscriber_id representation for I-JSON compliance.
	SubscriberIdStr string `json:"subscriber_id_str,omitempty"`
	IfpName         string `json:"ifp_name,omitempty"`
	// The MAC address of the physical interface  the subscriber is connected to.
	IfpMac string `json:"ifp_mac,omitempty"`
	// The inner VLAN (C-tag) associated with the subscriber.
	InnerVlan int `json:"inner_vlan,omitempty"`
	// The outer VLAN (S-tag) associated with the subscriber.
	OuterVlan int `json:"outer_vlan,omitempty"`
	// The client MAC address.
	ClientMac string `json:"client_mac,omitempty"`
	// The subscriber's username.
	SubscriberUserName string `json:"subscriber_user_name,omitempty"`
	// The subscriber's Agent-Remote-ID.
	AgentRemoteId string `json:"agent_remote_id,omitempty"`
	// The subscriber's Agent-Circuit-ID.
	AgentCircuitId string `json:"agent_circuit_id,omitempty"`
	// The name of the subscriber's logical interface.
	IflName    string                 `json:"ifl_name,omitempty"`
	AccessType *SubscriberAccessType  `json:"access_type,omitempty"`
	Ipv4       *SubscriberSessionIpv4 `json:"ipv4,omitempty"`
	Ipv6       *SubscriberSessionIpv6 `json:"ipv6,omitempty"`
	// The MTU level assigned to the subscriber.
	L3Mtu int `json:"l3_mtu,omitempty"`
	// The AAA profile name.
	AaaProfileName string `json:"aaa_profile_name,omitempty"`
	// The access profile name.
	AccessProfileName string `json:"access_profile_name,omitempty"`
	// The service profile name.
	ServiceProfileName string                    `json:"service_profile_name,omitempty"`
	Accounting         *SubscriberAccountingInfo `json:"accounting,omitempty"`
	Qos                *SubscriberQosProfile     `json:"qos,omitempty"`
	L2tp               *SubscriberSessionL2tp    `json:"l2tp,omitempty"`
	Pppoe              *SubscriberSessionPppoe   `json:"pppoe,omitempty"`
}

An active subscriber session.

type SubscriberSessionCounters ¶ added in v1.1.0

type SubscriberSessionCounters struct {
	// Number of sessions that are about to being established.
	Setup int `json:"setup,omitempty"`
	// Number of established session.
	Established int `json:"established,omitempty"`
	// Number of sessions that are about to being terminated.
	Terminating int `json:"terminating,omitempty"`
}

Session counters by session state.

type SubscriberSessionIpv4 ¶

type SubscriberSessionIpv4 struct {
	InstanceName string                       `json:"instance_name,omitempty"`
	Framed       *SubscriberSessionIpv4Framed `json:"framed,omitempty"`
	// Primary DNS IPv4 address.
	PrimaryDns string `json:"primary_dns,omitempty"`
	// Secondary DNS IPv4 address.
	SecondaryDns string `json:"secondary_dns,omitempty"`
}

Subscriber IPv4 settings

type SubscriberSessionIpv4Framed ¶

type SubscriberSessionIpv4Framed struct {
	// Wether the IPv4 address is active.
	Negotiated bool `json:"negotiated,omitempty"`
	// The assigned IPv4 address.
	Address string `json:"address,omitempty"`
	// The assigned IPv4 netmask.
	Netmask string `json:"netmask,omitempty"`
	// The IPv4 address pool name.
	PoolName string `json:"pool_name,omitempty"`
}

Framed IPv4 settings.

type SubscriberSessionIpv6 ¶

type SubscriberSessionIpv6 struct {
	InstanceName string                          `json:"instance_name,omitempty"`
	Framed       *SubscriberSessionIpv6Framed    `json:"framed,omitempty"`
	Delegated    *SubscriberSessionIpv6Delegated `json:"delegated,omitempty"`
	// Primary DNS IPv6 address
	PrimaryDns string `json:"primary_dns,omitempty"`
	// Secondary DNS IPv6 address
	SecondaryDns string `json:"secondary_dns,omitempty"`
}

Subscriber IPv6 settings.

type SubscriberSessionIpv6Delegated ¶

type SubscriberSessionIpv6Delegated struct {
	// Wether the delegated IPv6 prefix is active.
	Negotiated bool `json:"negotiated,omitempty"`
	// The assigned IPv6 prefix.
	Prefix string `json:"prefix,omitempty"`
	// The IPv6 address pool name.
	PoolName string `json:"pool_name,omitempty"`
}

Delegated IPv6 settings.

type SubscriberSessionIpv6Framed ¶

type SubscriberSessionIpv6Framed struct {
	// Wether the framed IPv6 prefix is active.
	Negotiated bool `json:"negotiated,omitempty"`
	// The assigned IPv6 prefix.
	Prefix string `json:"prefix,omitempty"`
	// The IPv6 address pool name.
	PoolName string `json:"pool_name,omitempty"`
}

Framed IPv6 settings.

type SubscriberSessionL2tp ¶

type SubscriberSessionL2tp struct {
	// The L2TP role which is either LAC or LNS.
	L2tpRole string `json:"l2tp_role,omitempty"`
}

L2TP specific settings.

type SubscriberSessionPppoe ¶

type SubscriberSessionPppoe struct {
	// The PPPoE session ID.
	PppoeSessionId int `json:"pppoe_session_id,omitempty"`
}

PPPoE specific settings.

type SubscriberSessionRef ¶

type SubscriberSessionRef struct {
	SubscriberId int `json:"subscriber_id,omitempty"`
	// String subscriber_id representation for I-JSON compliance.
	SubscriberIdStr    string `json:"subscriber_id_str,omitempty"`
	SubscriberUserName string `json:"subscriber_user_name,omitempty"`
	// The current subscriber FSM state.
	SubscriberState string                `json:"subscriber_state,omitempty"`
	AccessType      *SubscriberAccessType `json:"access_type,omitempty"`
	IfpName         string                `json:"ifp_name,omitempty"`
	InnerVlan       int                   `json:"inner_vlan,omitempty"`
	OuterVlan       int                   `json:"outer_vlan,omitempty"`
	// Client MAC address.
	ClientMac           string `json:"client_mac,omitempty"`
	AccountingSessionId string `json:"accounting_session_id,omitempty"`
	AgentRemoteId       string `json:"agent_remote_id,omitempty"`
	AgentCircuitId      string `json:"agent_circuit_id,omitempty"`
}

A reference to an active subscriber session.

type SubscriberSessionStatistics ¶ added in v1.1.0

type SubscriberSessionStatistics struct {
	Total *SubscriberSessionCounters `json:"total,omitempty"`
	Ipoe  *SubscriberSessionCounters `json:"ipoe,omitempty"`
	L2bsa *SubscriberSessionCounters `json:"l2bsa,omitempty"`
	L2tp  *SubscriberSessionCounters `json:"l2tp,omitempty"`
	Pppoe *SubscriberSessionCounters `json:"pppoe,omitempty"`
	Test  *SubscriberSessionCounters `json:"test,omitempty"`
	// Provides subscriber session counters per physical interface.
	IfpStatistics map[string]IfpSubscriberSessionStatistics `json:"ifp_statistics,omitempty"`
}

Subscriber session counters.

type SystemApiService ¶ added in v1.1.0

type SystemApiService service

func (*SystemApiService) GetSystemHardware ¶ added in v1.1.0

func (a *SystemApiService) GetSystemHardware(ctx context.Context) (SystemHardware, *http.Response, error)

SystemApiService Shows system hardware inventory Shows chassis, modules, and optics.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SystemHardware

type SystemHardware ¶ added in v1.1.0

type SystemHardware struct {
	Chassis *Chassis      `json:"chassis,omitempty"`
	Psus    []Psu         `json:"psus,omitempty"`
	Fans    []Fan         `json:"fans,omitempty"`
	Optics  []OpticModule `json:"optics,omitempty"`
}

System hardware inventory.

type TestAaaObject ¶

type TestAaaObject struct {
	// Subscriber ID.
	SubscriberId int `json:"subscriber_id"`
	// Name of the access profile.
	AccessProfileName string `json:"access_profile_name"`
	// Name of the AAA profile.
	AaaProfileName string `json:"aaa_profile_name"`
	// Username of the subscriber.
	SubscriberUserName string `json:"subscriber_user_name,omitempty"`
	// Password of the subscriber.
	Password string `json:"password,omitempty"`
	// Interface of the subscriber. *WARNING*: This attribute is deprecated. Please use <code>ifp_name</code> instead.
	InterfaceName string `json:"interface_name,omitempty"`
	// Mocked physical subscriber interface.
	IfpName string `json:"ifp_name,omitempty"`
	// The Agent-Remote-ID (ARI).
	AgentRemoteId string `json:"agent_remote_id,omitempty"`
	// The Agent-Circuit-ID (ACI).
	AgentCircuitId string `json:"agent_circuit_id,omitempty"`
	// Outer VLAN value.
	OuterVlan int `json:"outer_vlan,omitempty"`
	// Inner VLAN value.
	InnerVlan int `json:"inner_vlan,omitempty"`
	// MAC address of the subscriber.
	ClientMac string `json:"client_mac,omitempty"`
}

Test subscriber

type Traceroute ¶

type Traceroute struct {
	Traceroute *TracerouteArguments `json:"traceroute,omitempty"`
	// Array of hops to reach the destination.
	Hops []TracerouteHop `json:"hops,omitempty"`
	// The command to run traceroute in the RBFS CLI.
	Command string `json:"command,omitempty"`
	// The traceroute command output. One item per line.
	Output []string `json:"output,omitempty"`
}

The traceoute output

type TracerouteArguments ¶

type TracerouteArguments struct {
	// The destination IPv4 or IPv6 address.
	DestinationIp string `json:"destination_ip,omitempty"`
	InstanceName  string `json:"instance_name,omitempty"`
	// The source IPv4 or IPv6 address.
	SourceIp string `json:"source_ip,omitempty"`
	// The logical source interface.
	SourceIfl string `json:"source_ifl,omitempty"`
	// The maximum hops to reach the destination.
	MaxHops string `json:"max_hops,omitempty"`
	// The interval between to packages in seconds.
	Interval float64 `json:"interval,omitempty"`
	// The packet payload size in bytes.
	Size float64 `json:"size,omitempty"`
}

The traceroute parameters

type TracerouteHop ¶

type TracerouteHop struct {
	// The hop sequence number.
	Seq int `json:"seq,omitempty"`
	// The hop IPv4 or IPv6 addresses.
	Hop string `json:"hop,omitempty"`
	// Round-trip time (RTT) in seconds of the first packet sent by traceroute.
	Rtt1 float64 `json:"rtt_1,omitempty"`
	// Round-trip time (RTT) in seconds of the second packet sent by traceroute.
	Rtt2 float64 `json:"rtt_2,omitempty"`
	// Round-trip time (RTT) in seconds of the third packet sent by traceroute.
	Rtt3 float64 `json:"rtt_3,omitempty"`
}

type VlanProfile ¶

type VlanProfile struct {
	// Physical interface.
	IfpName string `json:"ifp_name"`
	// Outer VLAN range minimum value.
	OuterVlanMin int `json:"outer_vlan_min,omitempty"`
	// Outer VLAN range maximum value.
	OuterVlanMax int `json:"outer_vlan_max,omitempty"`
	// Inner VLAN range minimum value.
	InnerVlanMin int `json:"inner_vlan_min,omitempty"`
	// Inner VLAN range maximum value.
	InnerVlanMax int `json:"inner_vlan_max,omitempty"`
	// Name of the access profile.
	AccessProfileName string `json:"access_profile_name,omitempty"`
	// Name of the AAA profile.
	AaaProfileName string `json:"aaa_profile_name,omitempty"`
	// Name of the service profile.
	ServiceProfileName string `json:"service_profile_name,omitempty"`
}

List of VLAN profile objects

type VlanProfileBatch ¶ added in v1.1.0

type VlanProfileBatch struct {
	// VLAN profiles to be removed
	Remove []VlanProfile `json:"remove,omitempty"`
	// VLAN profiles to be stored
	Store []VlanProfile `json:"store,omitempty"`
}

Contains the VLAN profiles to be added or removed within a single batch operation.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL