apstra

package
v0.0.0-...-497c16d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2024 License: Apache-2.0 Imports: 34 Imported by: 13

Documentation

Index

Constants

View Source
const (
	RefDesignTwoStageL3Clos = RefDesign(iota)
	RefDesignFreeform
	RefDesignUnknown = "unknown reference design '%s'"
)
View Source
const (
	DeployStatusSuccess = DeployStatus(iota)
	DeployStatusFailure
	DeployStatusUnknown = "unknown deploy status '%s'"
)
View Source
const (
	PlatformOSCumulus = PlatformOS(iota)
	PlatformOSNxos
	PlatformOSEos
	PlatformOSJunos
	PlatformOSSonic
	PlatformOSUnknown = "unknown os '%s'"
)
View Source
const (
	ConfigletSectionSystem = ConfigletSection(iota)
	ConfigletSectionInterface
	ConfigletSectionFile
	ConfigletSectionFRR
	ConfigletSectionOSPF
	ConfigletSectionSystemTop
	ConfigletSectionSetBasedSystem
	ConfigletSectionSetBasedInterface
	ConfigletSectionDeleteBasedInterface
	ConfigletSectionUnknown = "unknown section '%s'"
)
View Source
const (
	PortIndexingVerticalFirst   = "L-R, T-B"
	PortIndexingHorizontalFirst = "T-B, L-R"
	PortIndexingSchemaAbsolute  = "absolute"
)
View Source
const (
	LogicalDevicePortRoleSpine = LogicalDevicePortRoleFlags(1 << iota)
	LogicalDevicePortRoleSuperspine
	LogicalDevicePortRoleLeaf
	LogicalDevicePortRoleAccess
	LogicalDevicePortRoleL3Server
	LogicalDevicePortRolePeer
	LogicalDevicePortRoleUnused
	LogicalDevicePortRoleGeneric
	LogicalDevicePortRoleUnknown = "unknown logical device port role '%s'"
)

class PortGroupSchema (scotch/schemas/logical_device.py) specifies: validate=validate.OneOf(

['spine', 'superspine', 'leaf', 'access',
 'l3_server', 'peer', 'unused', 'generic']
View Source
const (
	AccessRedundancyProtocolNone = AccessRedundancyProtocol(iota)
	AccessRedundancyProtocolEsi
	AccessRedundancyProtocolUnknown = "unknown redundancy protocol '%s'"
)
View Source
const (
	LeafRedundancyProtocolNone = LeafRedundancyProtocol(iota)
	LeafRedundancyProtocolMlag
	LeafRedundancyProtocolEsi
	LeafRedundancyProtocolUnknown = "unknown redundancy protocol '%s'"
)
View Source
const (
	FabricConnectivityDesignL3Clos = FabricConnectivityDesign(iota)
	FabricConnectivityDesignL3Collapsed
	FabricConnectivityDesignUnknown = "unknown connectivity design '%s'"
)
View Source
const (
	FeatureSwitchDisabled = FeatureSwitch(iota)
	FeatureSwitchEnabled
	FeatureSwitchUnknown = "unknown feature switch state '%s'"
)
View Source
const (
	SystemManagementLevelUnmanaged = SystemManagementLevel(iota)
	SystemManagementLevelTelemetryOnly
	SystemManagementLevelFullControl
	SystemManagementLevelNone
	SystemManagementLevelUnknown = "unknown generic system management level '%s'"
)
View Source
const (
	RackLinkAttachmentTypeSingle = RackLinkAttachmentType(iota)
	RackLinkAttachmentTypeDual
	RackLinkAttachmentTypeUnknown = "unknown link attachment scheme '%s'"
)
View Source
const (
	RackLinkLagModeNone = RackLinkLagMode(iota)
	RackLinkLagModeActive
	RackLinkLagModePassive
	RackLinkLagModeStatic
	RackLinkLagModeUnknown = "unknown lag mode '%s'"
)
View Source
const (
	RackLinkSwitchPeerNone = RackLinkSwitchPeer(iota)
	RackLinkSwitchPeerFirst
	RackLinkSwitchPeerSecond
	RackLinkSwitchPeerUnknown = "unknown switch peer '%s'"
)
View Source
const (
	AntiAffinityModeDisabled = AntiAffinityMode(iota)
	AntiAffinityModeEnabledLoose
	AntiAffinityModeEnabledStrict
	AntiAffinityModeLoose
	AntiAffinityModeStrict
	AntiAffinityModeUnknown = "unknown anti affinity mode %s"
)
View Source
const (
	AlgorithmHeuristic = AntiAffninityAlgorithm(iota)
	AlgorithmUnknown   = "unknown anti affinity algorithm '%s'"
)
View Source
const (
	TemplateTypeRackBased = TemplateType(iota)
	TemplateTypePodBased
	TemplateTypeL3Collapsed
	TemplateTypeNone
	TemplateTypeUnknown = "unknown template type '%s'"
)
View Source
const (
	AsnAllocationSchemeDistinct = AsnAllocationScheme(iota)
	AsnAllocationSchemeSingle
	AsnAllocationSchemeUnknown = "unknown asn allocation scheme '%s'"
)
View Source
const (
	AddressingSchemeIp4 = AddressingScheme(iota)
	AddressingSchemeIp6
	AddressingSchemeIp46
	AddressingSchemeUnknown = "unknown addressing scheme '%s'"
)
View Source
const (
	OverlayControlProtocolNone = OverlayControlProtocol(iota)
	OverlayControlProtocolEvpn
	OverlayControlProtocolUnknown = "unknown overlay control protocol '%s'"
)
View Source
const (
	TemplateCapabilityBlueprint = TemplateCapability(iota)
	TemplateCapabilityPod
	TemplateCapabilityNone
	TemplateCapabilityUnknown = "unknown template capability '%s'"
)
View Source
const (
	PoolStatusUnused = PoolStatus(iota)
	PoolStatusInUse
	PoolStatusDeleting
	PoolStatusCreating
	PoolStatusUnknown = "unknown redundancy protocol '%s'"
)
View Source
const (
	StreamingConfigSequencingModeSequenced   = "sequenced"
	StreamingConfigSequencingModeUnsequenced = "unsequenced"

	StreamingConfigStreamingTypeAlerts  = "alerts"
	StreamingConfigStreamingTypeEvents  = "events"
	StreamingConfigStreamingTypePerfmon = "perfmon"

	StreamingConfigProtocolProtoBufOverTcp = "protoBufOverTcp"
)
View Source
const (
	AgentCxnStateNone = AgentCxnState(iota)
	AgentCxnStateConnected
	AgentCxnStateDisconnected
	AgentCxnStateAuthFail
	AgentCxnStateUnknown
)
View Source
const (
	AgentJobTypeNull = AgentJobType(iota) // default type 0
	AgentJobTypeNone
	AgentJobTypeInstall
	AgentJobTypeCheck
	AgentJobTypeRevertToPristine
	AgentJobTypeUninstall
	AgentJobTypeUpgrade
	AgentJobTypeUnknown
)
View Source
const (
	AgentJobStateNull = AgentJobState(iota)
	AgentJobStateInit
	AgentJobStateInProgress
	AgentJobStateSuccess
	AgentJobStateFailed
	AgentJobStateUnknown
)
View Source
const (
	AgentPlatformNull = AgentPlatform(iota) // default type 0
	AgentPlatformJunos
	AgentPlatformEOS
	AgentPlatformNXOS
	AgentPlatformUnknown
)
View Source
const (
	SystemAdminStateNone = SystemAdminState(iota) // default type 0
	SystemAdminStateNormal
	SystemAdminStateDecomm
	SystemAdminStateMaint
	SystemAdminStateUnknown = "unknown system admin state '%s'"
)
View Source
const (
	DefaultTimeout = 10 * time.Second

	ErrUnknown = iota
	ErrAsnOutOfRange
	ErrAsnRangeOverlap
	ErrCannotChangeTransform
	ErrRangeOverlap
	ErrAuthFail
	ErrCompatibility
	ErrConflict
	ErrExists
	ErrInUse
	ErrMultipleMatch
	ErrNotfound
	ErrUncommitted
	ErrWrongType
	ErrReadOnly
	ErrCtAssignedToLink
	ErrTimeout
	ErrAgentProfilePlatformRequired
)
View Source
const (
	NodeTypeNone = NodeType(iota)
	NodeTypeAntiAffinityPolicy
	NodeTypeEpApplicationInstance
	NodeTypeDeviceProfile
	NodeTypeDomain
	NodeTypeEpEndpointPolicy
	NodeTypeEpGroup
	NodeTypeFabricAddressingPolicy
	NodeTypeFabricPolicy
	NodeTypeInterface
	NodeTypeInterfaceMap
	NodeTypeLink
	NodeTypeLogicalDevice
	NodeTypeMetadata
	NodeTypePolicy
	NodeTypeProtocol
	NodeTypeRack
	NodeTypeRedundancyGroup
	NodeTypeRouteTargetPolicy
	NodeTypeRoutingPolicy
	NodeTypeSecurityZone
	NodeTypeSecurityZonePolicy
	NodeTypeSystem
	NodeTypeTag
	NodeTypeVirtualNetwork
	NodeTypeVirtualNetworkInstance
	NodeTypeVirtualNetworkPolicy
	NodeTypeUnknown = "unknown node type %s"
)
View Source
const (
	RelationshipTypeNone = RelationshipType(iota)
	RelationshipTypeComposedOf
	RelationshipTypeComposedOfSystems
	RelationshipTypeDeviceProfile
	RelationshipTypeEpAffectedBy
	RelationshipTypeEpMemberOf
	RelationshipTypeEpNested
	RelationshipTypeEpTopLevel
	RelationshipTypeHostedInterfaces
	RelationshipTypeHostedVnInstances
	RelationshipTypeInterfaceMap
	RelationshipTypeInstantiatedBy
	RelationshipTypeInstantiates
	RelationshipTypeLink
	RelationshipTypeLogicalDevice
	RelationshipTypeMemberInterfaces
	RelationshipTypeMemberVNs
	RelationshipTypePartOfRack
	RelationshipTypePolicy
	RelationshipTypeProtocol
	RelationshipTypeRouteTargetPolicy
	RelationshipTypeSecurityPolicy
	RelationshipTypeTag
	RelationshipTypeUnknown = "unknown node type %s"
)
View Source
const (
	EnvApstraStreamHost     = "APSTRA_STREAM_HOST"
	EnvApstraStreamBasePort = "APSTRA_STREAM_BASE_PORT"
)
View Source
const (
	InterfaceTypeEthernet = InterfaceType(iota)
	InterfaceTypeIp
	InterfaceTypeLoopback
	InterfaceTypePortChannel
	InterfaceTypeSvi
	InterfaceTypeLogicalVtep
	InterfaceTypeAnycastVtep
	InterfaceTypeUnicastVtep
	InterfaceTypeGlobalAnycastVtep
	InterfaceTypeSubinterface
	InterfaceTypeUnknown = "unknown interface type '%s'"
)
View Source
const (
	InterfaceOperationStateNone = InterfaceOperationState(iota)
	InterfaceOperationStateUp
	InterfaceOperationStateDown
	InterfaceOperationStateAdminDown
	InterfaceOperationStateUnknown = "unknown interface operation state '%s'"
)
View Source
const (
	LinkRoleAccessL3PeerLink = LinkRole(iota)
	LinkRoleAccessServer
	LinkRoleLeafAccess
	LinkRoleLeafL2Server
	LinkRoleLeafL3PeerLink
	LinkRoleLeafL3Server
	LinkRoleLeafLeaf
	LinkRoleLeafPairAccess
	LinkRoleLeafPairAccessPair
	LinkRoleLeafPairL2Server
	LinkRoleLeafPeerLink
	LinkRoleSpineLeaf
	LinkRoleSpineSuperspine
	LinkRoleToExternalRouter
	LinkRoleToGeneric
	LinkRoleUnknown = "unknown link role '%s'"
)
View Source
const (
	SystemNodeRoleNone = SystemNodeRole(iota)
	SystemNodeRoleAccess
	SystemNodeRoleGeneric
	SystemNodeRoleL3Server
	SystemNodeRoleLeaf
	SystemNodeRoleRemoteGateway
	SystemNodeRoleSpine
	SystemNodeRoleSuperspine
	SystemNodeRoleUnknown = "unknown system node role '%s'"
)
View Source
const (
	LinkTypeAggregateLink = LinkType(iota)
	LinkTypeEthernet
	LinkTypeLogicalLink
	LinkTypeUnknown = "unknown link type '%s'"
)
View Source
const (
	BlueprintTypeNone = BlueprintType(iota)
	BlueprintTypeConfig
	BlueprintTypeDeployed
	BlueprintTypeOperation
	BlueprintTypeStaging
)
View Source
const (
	CtPrimitivePolicyTypeNameNone = CtPrimitivePolicyTypeName(iota)
	CtPrimitivePolicyTypeNameBatch
	CtPrimitivePolicyTypeNamePipeline
	CtPrimitivePolicyTypeNameAttachSingleVlan
	CtPrimitivePolicyTypeNameAttachMultipleVlan
	CtPrimitivePolicyTypeNameAttachLogicalLink
	CtPrimitivePolicyTypeNameAttachStaticRoute
	CtPrimitivePolicyTypeNameAttachCustomStaticRoute
	CtPrimitivePolicyTypeNameAttachIpEndpointWithBgpNsxt
	CtPrimitivePolicyTypeNameAttachBgpOverSubinterfacesOrSvi
	CtPrimitivePolicyTypeNameAttachBgpWithPrefixPeeringForSviOrSubinterface
	CtPrimitivePolicyTypeNameAttachExistingRoutingPolicy
	CtPrimitivePolicyTypeNameAttachRoutingZoneConstraint
	CtPrimitivePolicyTypeNameUnknown = "unknown CT primitive policy name %q"
)
View Source
const (
	CtPrimitiveBgpPeerToLoopback = CtPrimitiveBgpPeerTo(iota)
	CtPrimitiveBgpPeerToInterfaceOrIpEndpoint
	CtPrimitiveBgpPeerToInterfaceOrSharedIpEndpoint
	CtPrimitiveBgpPeerToUnknown = "unknown CtPrimitiveBgpPeerTo value %q"
)
View Source
const (
	CtPrimitiveIPv4ProtocolSessionAddressingNone = CtPrimitiveIPv4ProtocolSessionAddressing(iota)
	CtPrimitiveIPv4ProtocolSessionAddressingAddressed
	CtPrimitiveIPv4ProtocolSessionAddressingUnknown = "unknown CtPrimitiveIPv4ProtocolSessionAddressing value %q"
)
View Source
const (
	CtPrimitiveIPv6ProtocolSessionAddressingNone = CtPrimitiveIPv6ProtocolSessionAddressing(iota)
	CtPrimitiveIPv6ProtocolSessionAddressingAddressed
	CtPrimitiveIPv6ProtocolSessionAddressingLinkLocal
	CtPrimitiveIPv6ProtocolSessionAddressingUnknown = "unknown CtPrimitiveIPv6ProtocolSessionAddressing value %q"
)
View Source
const (
	CtPrimitiveIPv4AddressingTypeNone     = CtPrimitiveIPv4AddressingType(iota)
	CtPrimitiveIPv4AddressingTypeNumbered = CtPrimitiveIPv4AddressingType(iota)
	CtPrimitiveIPv4AddressingTypeUnknown  = "unknown CtPrimitiveIPv4AddressingType value %q"
)
View Source
const (
	CtPrimitiveIPv6AddressingTypeLinkLocal = CtPrimitiveIPv6AddressingType(iota)
	CtPrimitiveIPv6AddressingTypeNone
	CtPrimitiveIPv6AddressingTypeNumbered
	CtPrimitiveIPv6AddressingTypeUnknown = "unknown CtPrimitiveIPv6AddressingType value %q"
)
View Source
const (
	CtPrimitiveStatusAssigned = CtPrimitiveStatus(iota)
	CtPrimitiveStatusIncomplete
	CtPrimitiveStatusReady
	CtPrimitiveStatusUnknown = "unknown CtPrimitiveStatus value %q"
)
View Source
const (
	LockStatusUnlocked = LockStatus(iota)
	LockStatusLocked
	LockStatusLockedByRestrictedUser
	LockStatusLockedByAdmin
	LockStatusLockedByDeletedUser
	LockStatusUnknown = "unknown lock status %s"
)
View Source
const (
	ResourceTypeNone = ResourceType(iota)
	ResourceTypeAsnPool
	ResourceTypeIp4Pool
	ResourceTypeIp6Pool
	ResourceTypeVniPool
	ResourceTypeUnknown
)
View Source
const (
	ResourceGroupNameNone = ResourceGroupName(iota)
	ResourceGroupNameSuperspineAsn
	ResourceGroupNameSpineAsn
	ResourceGroupNameLeafAsn
	ResourceGroupNameAccessAsn
	ResourceGroupNameGenericAsn
	ResourceGroupNameSuperspineIp4
	ResourceGroupNameSuperspineIp6
	ResourceGroupNameSpineIp4
	ResourceGroupNameSpineIp6
	ResourceGroupNameLeafIp4
	ResourceGroupNameLeafIp6
	ResourceGroupNameAccessIp4
	ResourceGroupNameSuperspineSpineIp4
	ResourceGroupNameSuperspineSpineIp6
	ResourceGroupNameSpineLeafIp4
	ResourceGroupNameSpineLeafIp6
	ResourceGroupNameAccessAccessIp4
	ResourceGroupNameLeafLeafIp4
	ResourceGroupNameLeafL3PeerLinkLinkIp4
	ResourceGroupNameLeafL3PeerLinkLinkIp6
	ResourceGroupNameMlagDomainIp4
	ResourceGroupNameMlagDomainIp6
	ResourceGroupNameVtepIp4
	ResourceGroupNameEvpnL3Vni
	ResourceGroupNameVirtualNetworkSviIpv4
	ResourceGroupNameVirtualNetworkSviIpv6
	ResourceGroupNameVxlanVnIds
	ResourceGroupNameToGenericLinkIpv4
	ResourceGroupNameToGenericLinkIpv6
	ResourceGroupNameUnknown = "unknown group name %q"
)
View Source
const (
	DcRoutingPolicyTypeNone = DcRoutingPolicyType(iota)
	DcRoutingPolicyTypeDefault
	DcRoutingPolicyTypeUser
	DcRoutingPolicyTypeUnknown = "unknown datacenter routing policy type %q"
)
View Source
const (
	PrefixFilterActionNone = PrefixFilterAction(iota)
	PrefixFilterActionPermit
	PrefixFilterActionDeny
	PrefixFilterActionUnknown = "unknown prefix filter action %q"
)
View Source
const (
	DcRoutingPolicyImportPolicyNone = DcRoutingPolicyImportPolicy(iota)
	DcRoutingPolicyImportPolicyDefaultOnly
	DcRoutingPolicyImportPolicyAll
	DcRoutingPolicyImportPolicyExtraOnly
	DcRoutingPolicyImportPolicyUnknown = "unknown import policy %s"
)
View Source
const (
	SecurityZoneTypeNone = SecurityZoneType(iota)
	SecurityZoneTypeL3Fabric
	SecurityZoneTypeL3FabricVirtual
	SecurityZoneTypeEVPN
	SecurityZoneTypeUnknown = "unknown security zone type %s"
)
View Source
const (
	SystemTypeExternal = SystemType(iota)
	SystemTypeSwitch
	SystemTypeServer
	SystemTypeUnknown = "unknown system type '%s'"
)
View Source
const (
	SviIpRequirementNone = SviIpRequirement(iota)
	SviIpRequirementOptional
	SviIpRequirementForbidden
	SviIpRequirementMandatory
	SviIpRequirementIntentionConflict
	SviIpRequirementUnknown = "SVI IP requirement mode '%s' unknown"
)
View Source
const (
	Ipv4ModeNone = Ipv4Mode(iota)
	Ipv4ModeDisabled
	Ipv4ModeEnabled
	Ipv4ModeForced
	Ipv4ModeUnknown = "unknown IPv4 mode '%s'"
)
View Source
const (
	Ipv6ModeNone = Ipv6Mode(iota)
	Ipv6ModeDisabled
	Ipv6ModeEnabled
	Ipv6ModeForced
	Ipv6ModeLinkLocal
	Ipv6ModeUnknown = "unknown IPv6 mode '%s'"
)
View Source
const (
	VnTypeExternal = VnType(iota)
	VnTypeVlan
	VnTypeVxlan
	VnTypeUnknown = "unknown VN type '%s'"
)
View Source
const (
	SystemRoleNone = SystemRole(iota)
	SystemRoleAccess
	SystemRoleGeneric
	SystemRoleLeaf
	SystemRoleSpine
	SystemRoleSuperSpine
	SystemRoleRedundancyGroup
	SystemRoleUnknown = "unknown System Role '%s'"
)
View Source
const (
	Default_InterfaceCounters_DeltaSeconds = uint64(5)
)

Default values for InterfaceCounters fields.

View Source
const (
	ErrAgentNotConnect = iota
)

Variables

View Source
var (
	DeployModeDeploy   = DeployMode{Value: "deploy"}
	DeployModeDrain    = DeployMode{Value: "drain"}
	DeployModeNone     = DeployMode{Value: ""}
	DeployModeReady    = DeployMode{Value: "ready"}
	DeployModeUndeploy = DeployMode{Value: "undeploy"}
	DeployModes        = oenum.New(
		DeployModeDeploy,
		DeployModeDrain,
		DeployModeNone,
		DeployModeReady,
		DeployModeUndeploy,
	)

	DeviceProfileTypeModular    = DeviceProfileType{Value: "modular"}
	DeviceProfileTypeMonolithic = DeviceProfileType{Value: "monolithic"}
	DeviceProfileTypes          = oenum.New(DeviceProfileTypeModular, DeviceProfileTypeMonolithic)

	FeatureSwitchEnumEnabled  = FeatureSwitchEnum{Value: "enabled"}
	FeatureSwitchEnumDisabled = FeatureSwitchEnum{Value: "disabled"}
	FeatureSwitchEnums        = oenum.New(
		FeatureSwitchEnumEnabled,
		FeatureSwitchEnumDisabled,
	)

	IbaWidgetTypeStage          = IbaWidgetType{Value: "stage"}
	IbaWidgetTypeAnomalyHeatmap = IbaWidgetType{Value: "anomaly_heatmap"}
	IbaWidgetTypes              = oenum.New(
		IbaWidgetTypeStage,
		IbaWidgetTypeAnomalyHeatmap,
	)

	JunosEvpnIrbModeSymmetric  = JunosEvpnIrbMode{Value: "symmetric"}
	JunosEvpnIrbModeAsymmetric = JunosEvpnIrbMode{Value: "asymmetric"}
	JunosEvpnIrbModes          = oenum.New(
		JunosEvpnIrbModeSymmetric,
		JunosEvpnIrbModeAsymmetric,
	)

	PolicyApplicationPointTypeGroup          = PolicyApplicationPointType{Value: "group"}
	PolicyApplicationPointTypeInternal       = PolicyApplicationPointType{Value: "internal"}
	PolicyApplicationPointTypeExternal       = PolicyApplicationPointType{Value: "external"}
	PolicyApplicationPointTypeSecurityZone   = PolicyApplicationPointType{Value: "security_zone"}
	PolicyApplicationPointTypeVirtualNetwork = PolicyApplicationPointType{Value: "virtual_network"}
	PolicyApplicationPointTypes              = oenum.New(
		PolicyApplicationPointTypeGroup,
		PolicyApplicationPointTypeInternal,
		PolicyApplicationPointTypeExternal,
		PolicyApplicationPointTypeSecurityZone,
		PolicyApplicationPointTypeVirtualNetwork,
	)

	PolicyRuleActionDeny      = PolicyRuleAction{Value: "deny"}
	PolicyRuleActionDenyLog   = PolicyRuleAction{Value: "deny_log"}
	PolicyRuleActionPermit    = PolicyRuleAction{Value: "permit"}
	PolicyRuleActionPermitLog = PolicyRuleAction{Value: "permit_log"}
	PolicyRuleActions         = oenum.New(
		PolicyRuleActionDeny,
		PolicyRuleActionDenyLog,
		PolicyRuleActionPermit,
		PolicyRuleActionPermitLog,
	)

	PolicyRuleProtocolIcmp = PolicyRuleProtocol{Value: "ICMP"}
	PolicyRuleProtocolIp   = PolicyRuleProtocol{Value: "IP"}
	PolicyRuleProtocolTcp  = PolicyRuleProtocol{Value: "TCP"}
	PolicyRuleProtocolUdp  = PolicyRuleProtocol{Value: "UDP"}
	PolicyRuleProtocols    = oenum.New(
		PolicyRuleProtocolIcmp,
		PolicyRuleProtocolIp,
		PolicyRuleProtocolTcp,
		PolicyRuleProtocolUdp,
	)

	RemoteGatewayRouteTypesAll      = RemoteGatewayRouteTypes{Value: "all"}
	RemoteGatewayRouteTypesFiveOnly = RemoteGatewayRouteTypes{Value: "type5_only"}
	RemoteGatewayRouteTypesEnum     = oenum.New(
		RemoteGatewayRouteTypesAll,
		RemoteGatewayRouteTypesFiveOnly,
	)

	TcpStateQualifierEstablished = TcpStateQualifier{Value: "established"}
	TcpStateQualifiers           = oenum.New(
		TcpStateQualifierEstablished,
	)
)
View Source
var (
	DeviceState_name = map[int32]string{
		1:  "DEVICE_STATE_IS_ACTIVE",
		2:  "DEVICE_STATE_IS_READY",
		3:  "DEVICE_STATE_IS_NOCOMMS",
		4:  "DEVICE_STATE_IS_MAINT",
		5:  "DEVICE_STATE_IS_REBOOTING",
		6:  "DEVICE_STATE_OOS_STOCKED",
		7:  "DEVICE_STATE_OOS_QUARANTINED",
		8:  "DEVICE_STATE_OOS_READY",
		9:  "DEVICE_STATE_OOS_NOCOMMS",
		10: "DEVICE_STATE_OOS_DECOMM",
		11: "DEVICE_STATE_OOS_MAINT",
		12: "DEVICE_STATE_OOS_REBOOTING",
		13: "DEVICE_STATE_ERROR",
	}
	DeviceState_value = map[string]int32{
		"DEVICE_STATE_IS_ACTIVE":       1,
		"DEVICE_STATE_IS_READY":        2,
		"DEVICE_STATE_IS_NOCOMMS":      3,
		"DEVICE_STATE_IS_MAINT":        4,
		"DEVICE_STATE_IS_REBOOTING":    5,
		"DEVICE_STATE_OOS_STOCKED":     6,
		"DEVICE_STATE_OOS_QUARANTINED": 7,
		"DEVICE_STATE_OOS_READY":       8,
		"DEVICE_STATE_OOS_NOCOMMS":     9,
		"DEVICE_STATE_OOS_DECOMM":      10,
		"DEVICE_STATE_OOS_MAINT":       11,
		"DEVICE_STATE_OOS_REBOOTING":   12,
		"DEVICE_STATE_ERROR":           13,
	}
)

Enum value maps for DeviceState.

View Source
var (
	Feature_name = map[int32]string{
		0:  "FEATURE_UNKNOWN",
		1:  "FEATURE_LO0",
		2:  "FEATURE_FABRIC",
		3:  "FEATURE_LEAF_SERVER",
		4:  "FEATURE_L3EDGE",
		5:  "FEATURE_L2EDGE",
		6:  "FEATURE_SPINE_LEAF",
		7:  "FEATURE_FABRIC_SPINE",
		8:  "FEATURE_EXTERNAL_ROUTER",
		9:  "FEATURE_TO_EXTERNAL_ROUTER",
		10: "FEATURE_LEAF_L3_SERVER",
		11: "FEATURE_LEAF_L2_SERVER",
		12: "FEATURE_LEAF",
		13: "FEATURE_SPINE",
		14: "FEATURE_L3_SERVER",
		15: "FEATURE_L2_SERVER",
		16: "FEATURE_SERVER",
		17: "FEATURE_PEER",
		18: "FEATURE_LEAF_PEER_LINK",
		19: "FEATURE_LEAF_PAIR",
		20: "FEATURE_LEAF_PAIR_L2_SERVER",
		21: "FEATURE_UNUSED",
	}
	Feature_value = map[string]int32{
		"FEATURE_UNKNOWN":             0,
		"FEATURE_LO0":                 1,
		"FEATURE_FABRIC":              2,
		"FEATURE_LEAF_SERVER":         3,
		"FEATURE_L3EDGE":              4,
		"FEATURE_L2EDGE":              5,
		"FEATURE_SPINE_LEAF":          6,
		"FEATURE_FABRIC_SPINE":        7,
		"FEATURE_EXTERNAL_ROUTER":     8,
		"FEATURE_TO_EXTERNAL_ROUTER":  9,
		"FEATURE_LEAF_L3_SERVER":      10,
		"FEATURE_LEAF_L2_SERVER":      11,
		"FEATURE_LEAF":                12,
		"FEATURE_SPINE":               13,
		"FEATURE_L3_SERVER":           14,
		"FEATURE_L2_SERVER":           15,
		"FEATURE_SERVER":              16,
		"FEATURE_PEER":                17,
		"FEATURE_LEAF_PEER_LINK":      18,
		"FEATURE_LEAF_PAIR":           19,
		"FEATURE_LEAF_PAIR_L2_SERVER": 20,
		"FEATURE_UNUSED":              21,
	}
)

Enum value maps for Feature.

View Source
var (
	StreamingType_name = map[int32]string{
		0: "STREAMING_TYPE_PERFMON",
		1: "STREAMING_TYPE_EVENTS",
		2: "STREAMING_TYPE_ALERTS",
	}
	StreamingType_value = map[string]int32{
		"STREAMING_TYPE_PERFMON": 0,
		"STREAMING_TYPE_EVENTS":  1,
		"STREAMING_TYPE_ALERTS":  2,
	}
)

Enum value maps for StreamingType.

View Source
var (
	StreamingProtocol_name = map[int32]string{
		0: "STREAMING_PROTOCOL_PROTOBUF_OVER_TCP",
	}
	StreamingProtocol_value = map[string]int32{
		"STREAMING_PROTOCOL_PROTOBUF_OVER_TCP": 0,
	}
)

Enum value maps for StreamingProtocol.

View Source
var (
	StreamingStatus_name = map[int32]string{
		0: "STREAMING_STATUS_UP",
		1: "STREAMING_STATUS_DOWN",
	}
	StreamingStatus_value = map[string]int32{
		"STREAMING_STATUS_UP":   0,
		"STREAMING_STATUS_DOWN": 1,
	}
)

Enum value maps for StreamingStatus.

View Source
var (
	StreamingSequencingMode_name = map[int32]string{
		0: "STREAMING_UNSEQUENCED",
		1: "STREAMING_SEQUENCED",
	}
	StreamingSequencingMode_value = map[string]int32{
		"STREAMING_UNSEQUENCED": 0,
		"STREAMING_SEQUENCED":   1,
	}
)

Enum value maps for StreamingSequencingMode.

View Source
var (
	BgpSessionAddressFamily_name = map[int32]string{
		0: "IPV4",
		1: "IPV6",
		2: "EVPN",
	}
	BgpSessionAddressFamily_value = map[string]int32{
		"IPV4": 0,
		"IPV6": 1,
		"EVPN": 2,
	}
)

Enum value maps for BgpSessionAddressFamily.

View Source
var (
	LinkStatus_name = map[int32]string{
		0: "LINK_UP",
		1: "LINK_DOWN",
		2: "LINK_UNKNOWN",
		3: "LINK_MISSING",
	}
	LinkStatus_value = map[string]int32{
		"LINK_UP":      0,
		"LINK_DOWN":    1,
		"LINK_UNKNOWN": 2,
		"LINK_MISSING": 3,
	}
)

Enum value maps for LinkStatus.

View Source
var (
	MacState_name = map[int32]string{
		0: "MAC_ADD",
		1: "MAC_DELETE",
		2: "MAC_MOVE",
	}
	MacState_value = map[string]int32{
		"MAC_ADD":    0,
		"MAC_DELETE": 1,
		"MAC_MOVE":   2,
	}
)

Enum value maps for MacState.

View Source
var (
	ArpState_name = map[int32]string{
		0: "ARP_ADD",
		1: "ARP_DELETE",
	}
	ArpState_value = map[string]int32{
		"ARP_ADD":    0,
		"ARP_DELETE": 1,
	}
)

Enum value maps for ArpState.

View Source
var (
	MlagDomainState_name = map[int32]string{
		0: "MLAG_UNKNOWN",
		1: "MLAG_MISSING",
		2: "MLAG_DISABLED",
		3: "MLAG_INACTIVE",
		4: "MLAG_ACTIVE",
	}
	MlagDomainState_value = map[string]int32{
		"MLAG_UNKNOWN":  0,
		"MLAG_MISSING":  1,
		"MLAG_DISABLED": 2,
		"MLAG_INACTIVE": 3,
		"MLAG_ACTIVE":   4,
	}
)

Enum value maps for MlagDomainState.

View Source
var (
	MlagIntfState_name = map[int32]string{
		0: "MLAG_INTF_UNKNOWN",
		1: "MLAG_INTF_MISSING",
		2: "MLAG_INTF_DISABLED",
		3: "MLAG_INTF_CONFIGURED",
		4: "MLAG_INTF_INACTIVE",
		5: "MLAG_INTF_ACTIVE_PARTIAL",
		6: "MLAG_INTF_ACTIVE_FULL",
	}
	MlagIntfState_value = map[string]int32{
		"MLAG_INTF_UNKNOWN":        0,
		"MLAG_INTF_MISSING":        1,
		"MLAG_INTF_DISABLED":       2,
		"MLAG_INTF_CONFIGURED":     3,
		"MLAG_INTF_INACTIVE":       4,
		"MLAG_INTF_ACTIVE_PARTIAL": 5,
		"MLAG_INTF_ACTIVE_FULL":    6,
	}
)

Enum value maps for MlagIntfState.

View Source
var (
	RouteState_name = map[int32]string{
		0: "ROUTE_ADD",
		1: "ROUTE_DELETE",
	}
	RouteState_value = map[string]int32{
		"ROUTE_ADD":    0,
		"ROUTE_DELETE": 1,
	}
)

Enum value maps for RouteState.

View Source
var (
	AlertSeverity_name = map[int32]string{
		0: "ALERT_LOW",
		1: "ALERT_MEDIUM",
		2: "ALERT_HIGH",
		3: "ALERT_CRITICAL",
	}
	AlertSeverity_value = map[string]int32{
		"ALERT_LOW":      0,
		"ALERT_MEDIUM":   1,
		"ALERT_HIGH":     2,
		"ALERT_CRITICAL": 3,
	}
)

Enum value maps for AlertSeverity.

View Source
var (
	RouteEntryStatus_name = map[int32]string{
		0: "ROUTE_ENTRY_STATUS_UNKNOWN",
		1: "ROUTE_ENTRY_STATUS_UP",
		2: "ROUTE_ENTRY_STATUS_PARTIAL",
		3: "ROUTE_ENTRY_STATUS_MISSING",
	}
	RouteEntryStatus_value = map[string]int32{
		"ROUTE_ENTRY_STATUS_UNKNOWN": 0,
		"ROUTE_ENTRY_STATUS_UP":      1,
		"ROUTE_ENTRY_STATUS_PARTIAL": 2,
		"ROUTE_ENTRY_STATUS_MISSING": 3,
	}
)

Enum value maps for RouteEntryStatus.

View Source
var (
	NextHopStatus_name = map[int32]string{
		0: "NEXT_HOP_STATUS_UNKNOWN",
		1: "NEXT_HOP_STATUS_UP",
		2: "NEXT_HOP_STATUS_MISSING",
	}
	NextHopStatus_value = map[string]int32{
		"NEXT_HOP_STATUS_UNKNOWN": 0,
		"NEXT_HOP_STATUS_UP":      1,
		"NEXT_HOP_STATUS_MISSING": 2,
	}
)

Enum value maps for NextHopStatus.

View Source
var (
	RouteType_name = map[int32]string{
		0: "ROUTE_TYPE_UNKNOWN",
		1: "ROUTE_TYPE_DIRECT",
		2: "ROUTE_TYPE_BGP",
		3: "ROUTE_TYPE_STAT",
	}
	RouteType_value = map[string]int32{
		"ROUTE_TYPE_UNKNOWN": 0,
		"ROUTE_TYPE_DIRECT":  1,
		"ROUTE_TYPE_BGP":     2,
		"ROUTE_TYPE_STAT":    3,
	}
)

Enum value maps for RouteType.

View Source
var (
	DeploymentStatus_name = map[int32]string{
		0: "DEPLOYMENT_STATUS_INPROGRESS",
		1: "DEPLOYMENT_STATUS_SUCCEEDED",
		2: "DEPLOYMENT_STATUS_FAILED",
	}
	DeploymentStatus_value = map[string]int32{
		"DEPLOYMENT_STATUS_INPROGRESS": 0,
		"DEPLOYMENT_STATUS_SUCCEEDED":  1,
		"DEPLOYMENT_STATUS_FAILED":     2,
	}
)

Enum value maps for DeploymentStatus.

View Source
var (
	StreamingAlertReason_name = map[int32]string{
		0: "STREAMING_ALERT_REASON_FAILED_CONNECTION",
		1: "STREAMING_ALERT_REASON_TIMEOUT",
		2: "STREAMING_ALERT_REASON_DNS_FAILURE",
		3: "STREAMING_ALERT_REASON_WRITE_TIMEOUT",
	}
	StreamingAlertReason_value = map[string]int32{
		"STREAMING_ALERT_REASON_FAILED_CONNECTION": 0,
		"STREAMING_ALERT_REASON_TIMEOUT":           1,
		"STREAMING_ALERT_REASON_DNS_FAILURE":       2,
		"STREAMING_ALERT_REASON_WRITE_TIMEOUT":     3,
	}
)

Enum value maps for StreamingAlertReason.

View Source
var (
	BgpSessionState_name = map[int32]string{
		0: "BGP_SESSION_UP",
		1: "BGP_SESSION_DOWN",
		2: "BGP_SESSION_MISSING",
		3: "BGP_SESSION_UNKNOWN",
	}
	BgpSessionState_value = map[string]int32{
		"BGP_SESSION_UP":      0,
		"BGP_SESSION_DOWN":    1,
		"BGP_SESSION_MISSING": 2,
		"BGP_SESSION_UNKNOWN": 3,
	}
)

Enum value maps for BgpSessionState.

View Source
var (
	AggregationType_name = map[int32]string{
		1: "AGGREGATION_TYPE_MAX",
		2: "AGGREGATION_TYPE_MIN",
		3: "AGGREGATION_TYPE_SUM",
		4: "AGGREGATION_TYPE_AVG",
		5: "AGGREGATION_TYPE_STD",
	}
	AggregationType_value = map[string]int32{
		"AGGREGATION_TYPE_MAX": 1,
		"AGGREGATION_TYPE_MIN": 2,
		"AGGREGATION_TYPE_SUM": 3,
		"AGGREGATION_TYPE_AVG": 4,
		"AGGREGATION_TYPE_STD": 5,
	}
)

Enum value maps for AggregationType.

View Source
var (
	HeadroomType_name = map[int32]string{
		1: "HEADROOM_TYPE_MAX",
		2: "HEADROOM_TYPE_MIN",
	}
	HeadroomType_value = map[string]int32{
		"HEADROOM_TYPE_MAX": 1,
		"HEADROOM_TYPE_MIN": 2,
	}
)

Enum value maps for HeadroomType.

View Source
var File_apstra_streaming_telemetry_proto protoreflect.FileDescriptor

Functions

func CompareStreamingConfigs

func CompareStreamingConfigs(a *StreamingConfigParams, b *StreamingConfigParams) bool

CompareStreamingConfigs returns true if the supplied StreamingConfigInfo objects are likely to be recognized as a collision (ErrStringStreamingConfigExists) by the AOS API.

func IntRangeEqual

func IntRangeEqual(a, b IntfIntRange) bool

func IntRangeOverlap

func IntRangeOverlap(a, b IntfIntRange) bool

func SupportedApiVersions

func SupportedApiVersions() []string

SupportedApiVersions returns []string with each element representing an Apstra version number like "4.2.0"

Types

type AccessRedundancyProtocol

type AccessRedundancyProtocol int

func (*AccessRedundancyProtocol) FromString

func (o *AccessRedundancyProtocol) FromString(in string) error

func (AccessRedundancyProtocol) Int

func (o AccessRedundancyProtocol) Int() int

func (AccessRedundancyProtocol) String

func (o AccessRedundancyProtocol) String() string

type ActiveFloodlistEvent

type ActiveFloodlistEvent struct {
	State    *RouteState `protobuf:"varint,1,req,name=state,enum=aos.streaming.RouteState" json:"state,omitempty"`
	SystemId *string     `protobuf:"bytes,2,req,name=system_id,json=systemId" json:"system_id,omitempty"`
	Vni      *uint32     `protobuf:"varint,3,req,name=vni" json:"vni,omitempty"`
	Vtep     *string     `protobuf:"bytes,4,req,name=vtep" json:"vtep,omitempty"`
	// contains filtered or unexported fields
}

func (*ActiveFloodlistEvent) Descriptor deprecated

func (*ActiveFloodlistEvent) Descriptor() ([]byte, []int)

Deprecated: Use ActiveFloodlistEvent.ProtoReflect.Descriptor instead.

func (*ActiveFloodlistEvent) GetState

func (x *ActiveFloodlistEvent) GetState() RouteState

func (*ActiveFloodlistEvent) GetSystemId

func (x *ActiveFloodlistEvent) GetSystemId() string

func (*ActiveFloodlistEvent) GetVni

func (x *ActiveFloodlistEvent) GetVni() uint32

func (*ActiveFloodlistEvent) GetVtep

func (x *ActiveFloodlistEvent) GetVtep() string

func (*ActiveFloodlistEvent) ProtoMessage

func (*ActiveFloodlistEvent) ProtoMessage()

func (*ActiveFloodlistEvent) ProtoReflect

func (x *ActiveFloodlistEvent) ProtoReflect() protoreflect.Message

func (*ActiveFloodlistEvent) Reset

func (x *ActiveFloodlistEvent) Reset()

func (*ActiveFloodlistEvent) String

func (x *ActiveFloodlistEvent) String() string

type Actual

type Actual struct {
	Value string `json:"value"`
}

type AddressingScheme

type AddressingScheme int

func (*AddressingScheme) FromString

func (o *AddressingScheme) FromString(in string) error

func (AddressingScheme) Int

func (o AddressingScheme) Int() int

func (AddressingScheme) String

func (o AddressingScheme) String() string

type AgentCxnState

type AgentCxnState int

func (AgentCxnState) Int

func (o AgentCxnState) Int() int

func (AgentCxnState) String

func (o AgentCxnState) String() string

type AgentJobState

type AgentJobState int

func (AgentJobState) HasExited

func (o AgentJobState) HasExited() bool

func (AgentJobState) Int

func (o AgentJobState) Int() int

func (AgentJobState) String

func (o AgentJobState) String() string

type AgentJobStatus

type AgentJobStatus struct {
	Started         time.Time
	JobType         AgentJobType
	Finished        time.Time
	HostId          string
	CurrentTask     string
	IsLogAvailable  bool
	JobId           JobId
	Created         time.Time
	State           AgentJobState
	AgentTypeOffBox AgentTypeOffbox
	Error           string
}

type AgentJobType

type AgentJobType int

func (AgentJobType) Int

func (o AgentJobType) Int() int

func (AgentJobType) String

func (o AgentJobType) String() string

type AgentPackages

type AgentPackages map[string]string

type AgentPlatform

type AgentPlatform int

func (AgentPlatform) Int

func (o AgentPlatform) Int() int

func (AgentPlatform) String

func (o AgentPlatform) String() string

type AgentProfile

type AgentProfile struct {
	Label       string            `json:"label"`
	HasUsername bool              `json:"has_username"`
	HasPassword bool              `json:"has_password"`
	Platform    string            `json:"platform"`
	Packages    AgentPackages     `json:"packages"`
	Id          ObjectId          `json:"id"`
	OpenOptions map[string]string `json:"open_options"`
}

AgentProfile describes an Agent Profile to our callers. It has the Packages element presented sensibly as a map.

func (*AgentProfile) HasCredentials

func (o *AgentProfile) HasCredentials() bool

HasCredentials returns true if the AgentProfile has both username and password configured.

type AgentProfileConfig

type AgentProfileConfig struct {
	Label       string
	Username    *string
	Password    *string
	Platform    *string
	Packages    AgentPackages
	OpenOptions map[string]string
}

AgentProfileConfig is used when creating or updating an Agent Profile

type AgentStatus

type AgentStatus struct {
	ConnectionState   AgentCxnState
	PackagesInstalled AgentPackages
	CurrentTask       string
	PendingType       string
	JobId             JobId
	OperationMode     SystemManagementLevel
	PlatformVersion   string
	Platform          AgentPlatform
	State             string
	SystemId          SystemId
	HasCredential     bool
	Error             string
	StatusMessage     string
	AosVersion        string
}

type AgentTypeOffbox

type AgentTypeOffbox bool

type AggregationType

type AggregationType int32
const (
	AggregationType_AGGREGATION_TYPE_MAX AggregationType = 1
	AggregationType_AGGREGATION_TYPE_MIN AggregationType = 2
	AggregationType_AGGREGATION_TYPE_SUM AggregationType = 3
	AggregationType_AGGREGATION_TYPE_AVG AggregationType = 4
	AggregationType_AGGREGATION_TYPE_STD AggregationType = 5
)

func (AggregationType) Descriptor

func (AggregationType) Enum

func (x AggregationType) Enum() *AggregationType

func (AggregationType) EnumDescriptor deprecated

func (AggregationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AggregationType.Descriptor instead.

func (AggregationType) Number

func (AggregationType) String

func (x AggregationType) String() string

func (AggregationType) Type

func (*AggregationType) UnmarshalJSON deprecated

func (x *AggregationType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type Alert

type Alert struct {
	Severity  *AlertSeverity `protobuf:"varint,1,req,name=severity,enum=aos.streaming.AlertSeverity" json:"severity,omitempty"`
	FirstSeen *uint64        `protobuf:"varint,2,req,name=first_seen,json=firstSeen" json:"first_seen,omitempty"` // in microseconds since the epoch
	Id        *string        `protobuf:"bytes,3,req,name=id" json:"id,omitempty"`                                 // uuid
	Raised    *bool          `protobuf:"varint,4,req,name=raised" json:"raised,omitempty"`                        // true if raised, false if cleared
	// Types that are assignable to Data:
	//	*Alert_ConfigDeviationAlert
	//	*Alert_StreamingAlert
	//	*Alert_CablePeerMismatchAlert
	//	*Alert_BgpNeighborMismatchAlert
	//	*Alert_InterfaceLinkStatusMismatchAlert
	//	*Alert_HostnameAlert
	//	*Alert_RouteAlert
	//	*Alert_LivenessAlert
	//	*Alert_DeploymentAlert
	//	*Alert_BlueprintRenderingAlert
	//	*Alert_CountersAlert
	//	*Alert_MacAlert
	//	*Alert_ArpAlert
	//	*Alert_HeadroomAlert
	//	*Alert_LagAlert
	//	*Alert_MlagAlert
	//	*Alert_ProbeAlert
	//	*Alert_ConfigMismatchAlert
	//	*Alert_ExtensibleAlert
	//	*Alert_TestAlert
	Data isAlert_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

func (*Alert) Descriptor deprecated

func (*Alert) Descriptor() ([]byte, []int)

Deprecated: Use Alert.ProtoReflect.Descriptor instead.

func (*Alert) GetArpAlert

func (x *Alert) GetArpAlert() *ArpAlert

func (*Alert) GetBgpNeighborMismatchAlert

func (x *Alert) GetBgpNeighborMismatchAlert() *BGPNeighborMismatchAlert

func (*Alert) GetBlueprintRenderingAlert

func (x *Alert) GetBlueprintRenderingAlert() *BlueprintRenderingAlert

func (*Alert) GetCablePeerMismatchAlert

func (x *Alert) GetCablePeerMismatchAlert() *CablePeerMismatchAlert

func (*Alert) GetConfigDeviationAlert

func (x *Alert) GetConfigDeviationAlert() *ConfigDeviationAlert

func (*Alert) GetConfigMismatchAlert

func (x *Alert) GetConfigMismatchAlert() *ConfigMismatchAlert

func (*Alert) GetCountersAlert

func (x *Alert) GetCountersAlert() *CountersAlert

func (*Alert) GetData

func (m *Alert) GetData() isAlert_Data

func (*Alert) GetDeploymentAlert

func (x *Alert) GetDeploymentAlert() *DeploymentAlert

func (*Alert) GetExtensibleAlert

func (x *Alert) GetExtensibleAlert() *ExtensibleAlert

func (*Alert) GetFirstSeen

func (x *Alert) GetFirstSeen() uint64

func (*Alert) GetHeadroomAlert

func (x *Alert) GetHeadroomAlert() *HeadroomAlert

func (*Alert) GetHostnameAlert

func (x *Alert) GetHostnameAlert() *HostnameAlert

func (*Alert) GetId

func (x *Alert) GetId() string

func (*Alert) GetInterfaceLinkStatusMismatchAlert

func (x *Alert) GetInterfaceLinkStatusMismatchAlert() *InterfaceLinkStatusMismatchAlert

func (*Alert) GetLagAlert

func (x *Alert) GetLagAlert() *LagAlert

func (*Alert) GetLivenessAlert

func (x *Alert) GetLivenessAlert() *LivenessAlert

func (*Alert) GetMacAlert

func (x *Alert) GetMacAlert() *MacAlert

func (*Alert) GetMlagAlert

func (x *Alert) GetMlagAlert() *MlagAlert

func (*Alert) GetProbeAlert

func (x *Alert) GetProbeAlert() *ProbeAlert

func (*Alert) GetRaised

func (x *Alert) GetRaised() bool

func (*Alert) GetRouteAlert

func (x *Alert) GetRouteAlert() *RouteAlert

func (*Alert) GetSeverity

func (x *Alert) GetSeverity() AlertSeverity

func (*Alert) GetStreamingAlert

func (x *Alert) GetStreamingAlert() *StreamingAlert

func (*Alert) GetTestAlert

func (x *Alert) GetTestAlert() *TestAlert

func (*Alert) ProtoMessage

func (*Alert) ProtoMessage()

func (*Alert) ProtoReflect

func (x *Alert) ProtoReflect() protoreflect.Message

func (*Alert) Reset

func (x *Alert) Reset()

func (*Alert) String

func (x *Alert) String() string

type AlertSeverity

type AlertSeverity int32
const (
	AlertSeverity_ALERT_LOW      AlertSeverity = 0
	AlertSeverity_ALERT_MEDIUM   AlertSeverity = 1
	AlertSeverity_ALERT_HIGH     AlertSeverity = 2
	AlertSeverity_ALERT_CRITICAL AlertSeverity = 3
)

func (AlertSeverity) Descriptor

func (AlertSeverity) Enum

func (x AlertSeverity) Enum() *AlertSeverity

func (AlertSeverity) EnumDescriptor deprecated

func (AlertSeverity) EnumDescriptor() ([]byte, []int)

Deprecated: Use AlertSeverity.Descriptor instead.

func (AlertSeverity) Number

func (AlertSeverity) String

func (x AlertSeverity) String() string

func (AlertSeverity) Type

func (*AlertSeverity) UnmarshalJSON deprecated

func (x *AlertSeverity) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type Alert_ArpAlert

type Alert_ArpAlert struct {
	ArpAlert *ArpAlert `protobuf:"bytes,17,opt,name=arp_alert,json=arpAlert,oneof"`
}

type Alert_BgpNeighborMismatchAlert

type Alert_BgpNeighborMismatchAlert struct {
	BgpNeighborMismatchAlert *BGPNeighborMismatchAlert `protobuf:"bytes,8,opt,name=bgp_neighbor_mismatch_alert,json=bgpNeighborMismatchAlert,oneof"`
}

type Alert_BlueprintRenderingAlert

type Alert_BlueprintRenderingAlert struct {
	BlueprintRenderingAlert *BlueprintRenderingAlert `protobuf:"bytes,14,opt,name=blueprint_rendering_alert,json=blueprintRenderingAlert,oneof"`
}

type Alert_CablePeerMismatchAlert

type Alert_CablePeerMismatchAlert struct {
	CablePeerMismatchAlert *CablePeerMismatchAlert `protobuf:"bytes,7,opt,name=cable_peer_mismatch_alert,json=cablePeerMismatchAlert,oneof"`
}

type Alert_ConfigDeviationAlert

type Alert_ConfigDeviationAlert struct {
	ConfigDeviationAlert *ConfigDeviationAlert `protobuf:"bytes,5,opt,name=config_deviation_alert,json=configDeviationAlert,oneof"`
}

type Alert_ConfigMismatchAlert

type Alert_ConfigMismatchAlert struct {
	ConfigMismatchAlert *ConfigMismatchAlert `protobuf:"bytes,22,opt,name=config_mismatch_alert,json=configMismatchAlert,oneof"`
}

type Alert_CountersAlert

type Alert_CountersAlert struct {
	CountersAlert *CountersAlert `protobuf:"bytes,15,opt,name=counters_alert,json=countersAlert,oneof"`
}

type Alert_DeploymentAlert

type Alert_DeploymentAlert struct {
	DeploymentAlert *DeploymentAlert `protobuf:"bytes,13,opt,name=deployment_alert,json=deploymentAlert,oneof"`
}

type Alert_ExtensibleAlert

type Alert_ExtensibleAlert struct {
	ExtensibleAlert *ExtensibleAlert `protobuf:"bytes,23,opt,name=extensible_alert,json=extensibleAlert,oneof"`
}

type Alert_HeadroomAlert

type Alert_HeadroomAlert struct {
	// TODO(Rajeev): Headroom alert is obsoleted. The alert has to be removed
	// the next time backward compatibility breaking changes are made.
	HeadroomAlert *HeadroomAlert `protobuf:"bytes,18,opt,name=headroom_alert,json=headroomAlert,oneof"`
}

type Alert_HostnameAlert

type Alert_HostnameAlert struct {
	HostnameAlert *HostnameAlert `protobuf:"bytes,10,opt,name=hostname_alert,json=hostnameAlert,oneof"`
}

type Alert_InterfaceLinkStatusMismatchAlert

type Alert_InterfaceLinkStatusMismatchAlert struct {
	InterfaceLinkStatusMismatchAlert *InterfaceLinkStatusMismatchAlert `protobuf:"bytes,9,opt,name=interface_link_status_mismatch_alert,json=interfaceLinkStatusMismatchAlert,oneof"`
}

type Alert_LagAlert

type Alert_LagAlert struct {
	LagAlert *LagAlert `protobuf:"bytes,19,opt,name=lag_alert,json=lagAlert,oneof"`
}

type Alert_LivenessAlert

type Alert_LivenessAlert struct {
	LivenessAlert *LivenessAlert `protobuf:"bytes,12,opt,name=liveness_alert,json=livenessAlert,oneof"`
}

type Alert_MacAlert

type Alert_MacAlert struct {
	MacAlert *MacAlert `protobuf:"bytes,16,opt,name=mac_alert,json=macAlert,oneof"`
}

type Alert_MlagAlert

type Alert_MlagAlert struct {
	MlagAlert *MlagAlert `protobuf:"bytes,20,opt,name=mlag_alert,json=mlagAlert,oneof"`
}

type Alert_ProbeAlert

type Alert_ProbeAlert struct {
	ProbeAlert *ProbeAlert `protobuf:"bytes,21,opt,name=probe_alert,json=probeAlert,oneof"`
}

type Alert_RouteAlert

type Alert_RouteAlert struct {
	RouteAlert *RouteAlert `protobuf:"bytes,11,opt,name=route_alert,json=routeAlert,oneof"`
}

type Alert_StreamingAlert

type Alert_StreamingAlert struct {
	StreamingAlert *StreamingAlert `protobuf:"bytes,6,opt,name=streaming_alert,json=streamingAlert,oneof"`
}

type Alert_TestAlert

type Alert_TestAlert struct {
	TestAlert *TestAlert `protobuf:"bytes,1000,opt,name=test_alert,json=testAlert,oneof"`
}

type Anomalous

type Anomalous struct {
	Value    string `json:"value"`
	ValueMin string `json:"value_min"`
	ValueMax string `json:"value_max"`
}

type Anomaly

type Anomaly struct {
	Actual      Actual    `json:"actual"`
	Anomalous   Anomalous `json:"anomalous"`
	AnomalyType string    `json:"anomaly_type"`
	Id          ObjectId  `json:"id"`
	Identity    struct {
		AnomalyType string            `json:"anomaly_type"`
		ItemId      ObjectId          `json:"item_id"`
		ProbeId     ObjectId          `json:"probe_id"`
		ProbeLabel  string            `json:"probe_label"`
		Properties  []AnomalyProperty `json:"properties"`
		StageName   string            `json:"stage_name"`
	} `json:"identity"`
	LastModifiedAt time.Time `json:"last_modified_at"`
	Severity       string    `json:"severity"`
}

type AnomalyProperty

type AnomalyProperty struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type AntiAffinityMode

type AntiAffinityMode int

func (*AntiAffinityMode) FromString

func (o *AntiAffinityMode) FromString(s string) error

func (AntiAffinityMode) Int

func (o AntiAffinityMode) Int() int

func (AntiAffinityMode) String

func (o AntiAffinityMode) String() string

type AntiAffinityPolicy

type AntiAffinityPolicy struct {
	Algorithm                AntiAffninityAlgorithm
	MaxLinksPerPort          int
	MaxLinksPerSlot          int
	MaxPerSystemLinksPerPort int
	MaxPerSystemLinksPerSlot int
	Mode                     AntiAffinityMode
}

type AntiAffninityAlgorithm

type AntiAffninityAlgorithm int

func (AntiAffninityAlgorithm) Int

func (o AntiAffninityAlgorithm) Int() int

func (AntiAffninityAlgorithm) String

func (o AntiAffninityAlgorithm) String() string

type AosMessage

type AosMessage struct {
	Timestamp      *uint64 `protobuf:"varint,1,req,name=timestamp" json:"timestamp,omitempty"`                    // in microseconds since the epoch
	OriginName     *string `protobuf:"bytes,2,req,name=origin_name,json=originName" json:"origin_name,omitempty"` // originating entity name
	OriginHostname *string `protobuf:"bytes,6,opt,name=origin_hostname,json=originHostname" json:"origin_hostname,omitempty"`
	OriginRole     *string `protobuf:"bytes,7,opt,name=origin_role,json=originRole" json:"origin_role,omitempty"`
	BlueprintLabel *string `protobuf:"bytes,8,opt,name=blueprint_label,json=blueprintLabel" json:"blueprint_label,omitempty"`
	// Types that are assignable to Data:
	//	*AosMessage_Alert
	//	*AosMessage_Event
	//	*AosMessage_PerfMon
	Data isAosMessage_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

func (*AosMessage) Descriptor deprecated

func (*AosMessage) Descriptor() ([]byte, []int)

Deprecated: Use AosMessage.ProtoReflect.Descriptor instead.

func (*AosMessage) GetAlert

func (x *AosMessage) GetAlert() *Alert

func (*AosMessage) GetBlueprintLabel

func (x *AosMessage) GetBlueprintLabel() string

func (*AosMessage) GetData

func (m *AosMessage) GetData() isAosMessage_Data

func (*AosMessage) GetEvent

func (x *AosMessage) GetEvent() *Event

func (*AosMessage) GetOriginHostname

func (x *AosMessage) GetOriginHostname() string

func (*AosMessage) GetOriginName

func (x *AosMessage) GetOriginName() string

func (*AosMessage) GetOriginRole

func (x *AosMessage) GetOriginRole() string

func (*AosMessage) GetPerfMon

func (x *AosMessage) GetPerfMon() *PerfMon

func (*AosMessage) GetTimestamp

func (x *AosMessage) GetTimestamp() uint64

func (*AosMessage) ProtoMessage

func (*AosMessage) ProtoMessage()

func (*AosMessage) ProtoReflect

func (x *AosMessage) ProtoReflect() protoreflect.Message

func (*AosMessage) Reset

func (x *AosMessage) Reset()

func (*AosMessage) String

func (x *AosMessage) String() string

type AosMessage_Alert

type AosMessage_Alert struct {
	Alert *Alert `protobuf:"bytes,3,opt,name=alert,oneof"`
}

type AosMessage_Event

type AosMessage_Event struct {
	Event *Event `protobuf:"bytes,4,opt,name=event,oneof"`
}

type AosMessage_PerfMon

type AosMessage_PerfMon struct {
	PerfMon *PerfMon `protobuf:"bytes,5,opt,name=perf_mon,json=perfMon,oneof"`
}

type AosSequencedMessage

type AosSequencedMessage struct {
	SeqNum *uint64 `protobuf:"varint,1,opt,name=seq_num,json=seqNum" json:"seq_num,omitempty"`
	// space for preceding fields
	AosProto []byte `protobuf:"bytes,15,opt,name=aos_proto,json=aosProto" json:"aos_proto,omitempty"` // serialized AosMessage
	// contains filtered or unexported fields
}

func (*AosSequencedMessage) Descriptor deprecated

func (*AosSequencedMessage) Descriptor() ([]byte, []int)

Deprecated: Use AosSequencedMessage.ProtoReflect.Descriptor instead.

func (*AosSequencedMessage) GetAosProto

func (x *AosSequencedMessage) GetAosProto() []byte

func (*AosSequencedMessage) GetSeqNum

func (x *AosSequencedMessage) GetSeqNum() uint64

func (*AosSequencedMessage) ProtoMessage

func (*AosSequencedMessage) ProtoMessage()

func (*AosSequencedMessage) ProtoReflect

func (x *AosSequencedMessage) ProtoReflect() protoreflect.Message

func (*AosSequencedMessage) Reset

func (x *AosSequencedMessage) Reset()

func (*AosSequencedMessage) String

func (x *AosSequencedMessage) String() string

type ArpAlert

type ArpAlert struct {
	Ipaddress *string `protobuf:"bytes,1,req,name=ipaddress" json:"ipaddress,omitempty"`
	Mac       *string `protobuf:"bytes,2,req,name=mac" json:"mac,omitempty"`
	Intfname  *string `protobuf:"bytes,3,req,name=intfname" json:"intfname,omitempty"`
	// contains filtered or unexported fields
}

func (*ArpAlert) Descriptor deprecated

func (*ArpAlert) Descriptor() ([]byte, []int)

Deprecated: Use ArpAlert.ProtoReflect.Descriptor instead.

func (*ArpAlert) GetIntfname

func (x *ArpAlert) GetIntfname() string

func (*ArpAlert) GetIpaddress

func (x *ArpAlert) GetIpaddress() string

func (*ArpAlert) GetMac

func (x *ArpAlert) GetMac() string

func (*ArpAlert) ProtoMessage

func (*ArpAlert) ProtoMessage()

func (*ArpAlert) ProtoReflect

func (x *ArpAlert) ProtoReflect() protoreflect.Message

func (*ArpAlert) Reset

func (x *ArpAlert) Reset()

func (*ArpAlert) String

func (x *ArpAlert) String() string

type ArpEvent

type ArpEvent struct {
	Ipaddress *string   `protobuf:"bytes,1,req,name=ipaddress" json:"ipaddress,omitempty"`
	Mac       *string   `protobuf:"bytes,2,req,name=mac" json:"mac,omitempty"`
	Intfname  *string   `protobuf:"bytes,3,req,name=intfname" json:"intfname,omitempty"`
	State     *ArpState `protobuf:"varint,4,req,name=state,enum=aos.streaming.ArpState" json:"state,omitempty"`
	Vrfname   *string   `protobuf:"bytes,5,req,name=vrfname" json:"vrfname,omitempty"`
	// contains filtered or unexported fields
}

func (*ArpEvent) Descriptor deprecated

func (*ArpEvent) Descriptor() ([]byte, []int)

Deprecated: Use ArpEvent.ProtoReflect.Descriptor instead.

func (*ArpEvent) GetIntfname

func (x *ArpEvent) GetIntfname() string

func (*ArpEvent) GetIpaddress

func (x *ArpEvent) GetIpaddress() string

func (*ArpEvent) GetMac

func (x *ArpEvent) GetMac() string

func (*ArpEvent) GetState

func (x *ArpEvent) GetState() ArpState

func (*ArpEvent) GetVrfname

func (x *ArpEvent) GetVrfname() string

func (*ArpEvent) ProtoMessage

func (*ArpEvent) ProtoMessage()

func (*ArpEvent) ProtoReflect

func (x *ArpEvent) ProtoReflect() protoreflect.Message

func (*ArpEvent) Reset

func (x *ArpEvent) Reset()

func (*ArpEvent) String

func (x *ArpEvent) String() string

type ArpState

type ArpState int32
const (
	ArpState_ARP_ADD    ArpState = 0
	ArpState_ARP_DELETE ArpState = 1
)

func (ArpState) Descriptor

func (ArpState) Descriptor() protoreflect.EnumDescriptor

func (ArpState) Enum

func (x ArpState) Enum() *ArpState

func (ArpState) EnumDescriptor deprecated

func (ArpState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ArpState.Descriptor instead.

func (ArpState) Number

func (x ArpState) Number() protoreflect.EnumNumber

func (ArpState) String

func (x ArpState) String() string

func (ArpState) Type

func (*ArpState) UnmarshalJSON deprecated

func (x *ArpState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type AsnAllocationPolicy

type AsnAllocationPolicy struct {
	SpineAsnScheme AsnAllocationScheme
}

type AsnAllocationScheme

type AsnAllocationScheme int

func (*AsnAllocationScheme) FromString

func (o *AsnAllocationScheme) FromString(in string) error

func (AsnAllocationScheme) Int

func (o AsnAllocationScheme) Int() int

func (AsnAllocationScheme) String

func (o AsnAllocationScheme) String() string

type AsnPool

type AsnPool IntPool

AsnPool is the public structure used to convey query responses about ASN pools.

type AsnPoolRequest

type AsnPoolRequest IntPoolRequest

AsnPoolRequest is the public structure used to create/update an ASN pool.

type AssignAgentProfileRequest

type AssignAgentProfileRequest struct {
	SystemAgents     []ObjectId `json:"system_agents"`
	ProfileId        ObjectId   `json:"profile_id"`
	ClearPackages    bool       `json:"clear_packages"`
	ClearOpenOptions bool       `json:"clear_open_options"`
}

type AuditConfig

type AuditConfig struct {
	Syslogs []string `json:"syslogs"`
}

type BGPNeighborEvent

type BGPNeighborEvent struct {
	LclHostname *string                  `protobuf:"bytes,1,req,name=lcl_hostname,json=lclHostname" json:"lcl_hostname,omitempty"`
	LclIpaddr   *string                  `protobuf:"bytes,2,req,name=lcl_ipaddr,json=lclIpaddr" json:"lcl_ipaddr,omitempty"`
	LclAsn      *uint32                  `protobuf:"varint,3,req,name=lcl_asn,json=lclAsn" json:"lcl_asn,omitempty"`
	State       *BgpSessionState         `protobuf:"varint,4,req,name=state,enum=aos.streaming.BgpSessionState" json:"state,omitempty"`
	RmtIpaddr   *string                  `protobuf:"bytes,5,req,name=rmt_ipaddr,json=rmtIpaddr" json:"rmt_ipaddr,omitempty"`
	RmtAsn      *uint32                  `protobuf:"varint,6,req,name=rmt_asn,json=rmtAsn" json:"rmt_asn,omitempty"`
	VrfName     *string                  `protobuf:"bytes,7,req,name=vrf_name,json=vrfName" json:"vrf_name,omitempty"`
	AddrFamily  *BgpSessionAddressFamily `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*BGPNeighborEvent) Descriptor deprecated

func (*BGPNeighborEvent) Descriptor() ([]byte, []int)

Deprecated: Use BGPNeighborEvent.ProtoReflect.Descriptor instead.

func (*BGPNeighborEvent) GetAddrFamily

func (x *BGPNeighborEvent) GetAddrFamily() BgpSessionAddressFamily

func (*BGPNeighborEvent) GetLclAsn

func (x *BGPNeighborEvent) GetLclAsn() uint32

func (*BGPNeighborEvent) GetLclHostname

func (x *BGPNeighborEvent) GetLclHostname() string

func (*BGPNeighborEvent) GetLclIpaddr

func (x *BGPNeighborEvent) GetLclIpaddr() string

func (*BGPNeighborEvent) GetRmtAsn

func (x *BGPNeighborEvent) GetRmtAsn() uint32

func (*BGPNeighborEvent) GetRmtIpaddr

func (x *BGPNeighborEvent) GetRmtIpaddr() string

func (*BGPNeighborEvent) GetState

func (x *BGPNeighborEvent) GetState() BgpSessionState

func (*BGPNeighborEvent) GetVrfName

func (x *BGPNeighborEvent) GetVrfName() string

func (*BGPNeighborEvent) ProtoMessage

func (*BGPNeighborEvent) ProtoMessage()

func (*BGPNeighborEvent) ProtoReflect

func (x *BGPNeighborEvent) ProtoReflect() protoreflect.Message

func (*BGPNeighborEvent) Reset

func (x *BGPNeighborEvent) Reset()

func (*BGPNeighborEvent) String

func (x *BGPNeighborEvent) String() string

type BGPNeighborMismatchAlert

type BGPNeighborMismatchAlert struct {
	LclHostname   *string                  `protobuf:"bytes,1,req,name=lcl_hostname,json=lclHostname" json:"lcl_hostname,omitempty"`
	LclIpaddr     *string                  `protobuf:"bytes,2,req,name=lcl_ipaddr,json=lclIpaddr" json:"lcl_ipaddr,omitempty"`
	LclAsn        *uint32                  `protobuf:"varint,3,req,name=lcl_asn,json=lclAsn" json:"lcl_asn,omitempty"`
	RmtIpaddr     *string                  `protobuf:"bytes,4,req,name=rmt_ipaddr,json=rmtIpaddr" json:"rmt_ipaddr,omitempty"`
	RmtAsn        *uint32                  `protobuf:"varint,5,req,name=rmt_asn,json=rmtAsn" json:"rmt_asn,omitempty"`
	ExpectedState *BgpSessionState         `` /* 129-byte string literal not displayed */
	ActualState   *BgpSessionState         `protobuf:"varint,7,req,name=actual_state,json=actualState,enum=aos.streaming.BgpSessionState" json:"actual_state,omitempty"`
	RmtName       *string                  `protobuf:"bytes,8,req,name=rmt_name,json=rmtName" json:"rmt_name,omitempty"`
	VrfName       *string                  `protobuf:"bytes,9,req,name=vrf_name,json=vrfName" json:"vrf_name,omitempty"`
	AddrFamily    *BgpSessionAddressFamily `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*BGPNeighborMismatchAlert) Descriptor deprecated

func (*BGPNeighborMismatchAlert) Descriptor() ([]byte, []int)

Deprecated: Use BGPNeighborMismatchAlert.ProtoReflect.Descriptor instead.

func (*BGPNeighborMismatchAlert) GetActualState

func (x *BGPNeighborMismatchAlert) GetActualState() BgpSessionState

func (*BGPNeighborMismatchAlert) GetAddrFamily

func (*BGPNeighborMismatchAlert) GetExpectedState

func (x *BGPNeighborMismatchAlert) GetExpectedState() BgpSessionState

func (*BGPNeighborMismatchAlert) GetLclAsn

func (x *BGPNeighborMismatchAlert) GetLclAsn() uint32

func (*BGPNeighborMismatchAlert) GetLclHostname

func (x *BGPNeighborMismatchAlert) GetLclHostname() string

func (*BGPNeighborMismatchAlert) GetLclIpaddr

func (x *BGPNeighborMismatchAlert) GetLclIpaddr() string

func (*BGPNeighborMismatchAlert) GetRmtAsn

func (x *BGPNeighborMismatchAlert) GetRmtAsn() uint32

func (*BGPNeighborMismatchAlert) GetRmtIpaddr

func (x *BGPNeighborMismatchAlert) GetRmtIpaddr() string

func (*BGPNeighborMismatchAlert) GetRmtName

func (x *BGPNeighborMismatchAlert) GetRmtName() string

func (*BGPNeighborMismatchAlert) GetVrfName

func (x *BGPNeighborMismatchAlert) GetVrfName() string

func (*BGPNeighborMismatchAlert) ProtoMessage

func (*BGPNeighborMismatchAlert) ProtoMessage()

func (*BGPNeighborMismatchAlert) ProtoReflect

func (x *BGPNeighborMismatchAlert) ProtoReflect() protoreflect.Message

func (*BGPNeighborMismatchAlert) Reset

func (x *BGPNeighborMismatchAlert) Reset()

func (*BGPNeighborMismatchAlert) String

func (x *BGPNeighborMismatchAlert) String() string

type BgpSessionAddressFamily

type BgpSessionAddressFamily int32
const (
	BgpSessionAddressFamily_IPV4 BgpSessionAddressFamily = 0
	BgpSessionAddressFamily_IPV6 BgpSessionAddressFamily = 1
	BgpSessionAddressFamily_EVPN BgpSessionAddressFamily = 2
)

func (BgpSessionAddressFamily) Descriptor

func (BgpSessionAddressFamily) Enum

func (BgpSessionAddressFamily) EnumDescriptor deprecated

func (BgpSessionAddressFamily) EnumDescriptor() ([]byte, []int)

Deprecated: Use BgpSessionAddressFamily.Descriptor instead.

func (BgpSessionAddressFamily) Number

func (BgpSessionAddressFamily) String

func (x BgpSessionAddressFamily) String() string

func (BgpSessionAddressFamily) Type

func (*BgpSessionAddressFamily) UnmarshalJSON deprecated

func (x *BgpSessionAddressFamily) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type BgpSessionState

type BgpSessionState int32
const (
	BgpSessionState_BGP_SESSION_UP      BgpSessionState = 0
	BgpSessionState_BGP_SESSION_DOWN    BgpSessionState = 1
	BgpSessionState_BGP_SESSION_MISSING BgpSessionState = 2
	BgpSessionState_BGP_SESSION_UNKNOWN BgpSessionState = 3
)

func (BgpSessionState) Descriptor

func (BgpSessionState) Enum

func (x BgpSessionState) Enum() *BgpSessionState

func (BgpSessionState) EnumDescriptor deprecated

func (BgpSessionState) EnumDescriptor() ([]byte, []int)

Deprecated: Use BgpSessionState.Descriptor instead.

func (BgpSessionState) Number

func (BgpSessionState) String

func (x BgpSessionState) String() string

func (BgpSessionState) Type

func (*BgpSessionState) UnmarshalJSON deprecated

func (x *BgpSessionState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type Blueprint

type Blueprint struct {
	Id             ObjectId
	Version        int
	Design         RefDesign
	LastModifiedAt time.Time
	Label          string
	Relationships  map[string]json.RawMessage
	Nodes          map[string]json.RawMessage
	SourceVersions struct {
		ConfigBlueprint int
	}
	// contains filtered or unexported fields
}

type BlueprintAnomaly

type BlueprintAnomaly struct {
	Id             ObjectId   `json:"id"`               // part of base schema
	LastModifiedAt *time.Time `json:"last_modified_at"` // part of base schema
	Severity       string     `json:"severity"`         // part of base schema
	AnomalyType    string     `json:"anomaly_type"`     // part of base schema

	Actual    json.RawMessage `json:"actual"`    // universal (near universal?)
	Expected  json.RawMessage `json:"expected"`  // universal (near universal?)
	Identity  json.RawMessage `json:"identity"`  // universal (near universal?)
	Role      *string         `json:"role"`      // near universal
	Anomalous json.RawMessage `json:"anomalous"` // probe
}

type BlueprintAnomalyCounts

type BlueprintAnomalyCounts struct {
	Arp                int `json:"arp"`
	Probe              int `json:"probe"`
	Hostname           int `json:"hostname"`
	Streaming          int `json:"streaming"`
	Series             int `json:"series"`
	Cabling            int `json:"cabling"`
	Route              int `json:"route"`
	Counter            int `json:"counter"`
	All                int `json:"all"`
	Bgp                int `json:"bgp"`
	BlueprintRendering int `json:"blueprint_rendering"`
	Mac                int `json:"mac"`
	Mlag               int `json:"mlag"`
	Deployment         int `json:"deployment"`
	Interface          int `json:"interface"`
	Liveness           int `json:"liveness"`
	Config             int `json:"config"`
	Lag                int `json:"lag"`
}

type BlueprintDeployRequest

type BlueprintDeployRequest struct {
	Id          ObjectId
	Description string
	Version     int
}

type BlueprintDeployResponse

type BlueprintDeployResponse struct {
	Status  DeployStatus `json:"state"`
	Version int          `json:"version"`
	Error   *string      `json:"error,omitempty"`
}

type BlueprintDeploymentStatus

type BlueprintDeploymentStatus struct {
	ServiceConfig struct {
		NumSucceeded int `json:"num_succeeded"`
		NumFailed    int `json:"num_failed"`
		NumPending   int `json:"num_pending"`
	} `json:"service_config"`
	DrainConfig struct {
		NumSucceeded int `json:"num_succeeded"`
		NumFailed    int `json:"num_failed"`
		NumPending   int `json:"num_pending"`
	} `json:"drain_config"`
	Discovery2Config struct {
		NumSucceeded int `json:"num_succeeded"`
		NumFailed    int `json:"num_failed"`
		NumPending   int `json:"num_pending"`
	} `json:"discovery2_config"`
}

type BlueprintNodeAnomalyCounts

type BlueprintNodeAnomalyCounts struct {
	Node     string   `json:"node"`
	SystemId ObjectId `json:"system_id"`
	All      int      `json:"all"`

	Arp                int `json:"arp"`
	Bgp                int `json:"bgp"`
	BlueprintRendering int `json:"blueprint_rendering"`
	Cabling            int `json:"cabling"`
	Config             int `json:"config"`
	Counter            int `json:"counter"`
	Deployment         int `json:"deployment"`
	Hostname           int `json:"hostname"`
	Interface          int `json:"interface"`
	Lag                int `json:"lag"`
	Liveness           int `json:"liveness"`
	Mac                int `json:"mac"`
	Mlag               int `json:"mlag"`
	Probe              int `json:"probe"`
	Route              int `json:"route"`
	Series             int `json:"series"`
	Streaming          int `json:"streaming"`
}

type BlueprintRenderingAlert

type BlueprintRenderingAlert struct {
	FailedSystems []string `protobuf:"bytes,1,rep,name=failed_systems,json=failedSystems" json:"failed_systems,omitempty"`
	// contains filtered or unexported fields
}

func (*BlueprintRenderingAlert) Descriptor deprecated

func (*BlueprintRenderingAlert) Descriptor() ([]byte, []int)

Deprecated: Use BlueprintRenderingAlert.ProtoReflect.Descriptor instead.

func (*BlueprintRenderingAlert) GetFailedSystems

func (x *BlueprintRenderingAlert) GetFailedSystems() []string

func (*BlueprintRenderingAlert) ProtoMessage

func (*BlueprintRenderingAlert) ProtoMessage()

func (*BlueprintRenderingAlert) ProtoReflect

func (x *BlueprintRenderingAlert) ProtoReflect() protoreflect.Message

func (*BlueprintRenderingAlert) Reset

func (x *BlueprintRenderingAlert) Reset()

func (*BlueprintRenderingAlert) String

func (x *BlueprintRenderingAlert) String() string

type BlueprintRequestFabricAddressingPolicy

type BlueprintRequestFabricAddressingPolicy struct {
	SpineSuperspineLinks AddressingScheme
	SpineLeafLinks       AddressingScheme
	FabricL3Mtu          *uint16
}

type BlueprintRevision

type BlueprintRevision struct {
	Description string
	CreatedAt   time.Time
	AutoSaved   bool
	UserSaved   bool
	UserIp      net.IP
	User        string
	RevisionId  int
}

type BlueprintServiceAnomalyCount

type BlueprintServiceAnomalyCount struct {
	AnomalyType string `json:"type"`
	Role        string `json:"role"`
	Count       int    `json:"count"`
}

type BlueprintStatus

type BlueprintStatus struct {
	Id                     ObjectId                  `json:"id"`
	Label                  string                    `json:"label"`
	Status                 string                    `json:"status"`
	Design                 RefDesign                 `json:"design"`
	HasUncommittedChanges  bool                      `json:"has_uncommitted_changes"`
	Version                int                       `json:"version"`
	LastModifiedAt         time.Time                 `json:"last_modified_at"`
	SuperspineCount        int                       `json:"superspine_count"`
	SpineCount             int                       `json:"spine_count"`
	LeafCount              int                       `json:"leaf_count"`
	AccessCount            int                       `json:"access_count"`
	GenericCount           int                       `json:"generic_count"`
	ExternalRouterCount    int                       `json:"external_router_count"`
	L2ServerCount          int                       `json:"l2_server_count"`
	L3ServerCount          int                       `json:"l3_server_count"`
	RemoteGatewayCount     int                       `json:"remote_gateway_count"`
	BuildWarningsCount     int                       `json:"build_warnings_count"`
	RootCauseCount         int                       `json:"root_cause_count"`
	TopLevelRootCauseCount int                       `json:"top_level_root_cause_count"`
	BuildErrorsCount       int                       `json:"build_errors_count"`
	DeploymentStatus       BlueprintDeploymentStatus `json:"deployment_status"`
	AnomalyCounts          BlueprintAnomalyCounts    `json:"anomaly_counts"`
}

type BlueprintType

type BlueprintType int

type CablePeerEvent

type CablePeerEvent struct {
	LclDeviceId *string `protobuf:"bytes,1,req,name=lcl_device_id,json=lclDeviceId" json:"lcl_device_id,omitempty"`
	LclHostname *string `protobuf:"bytes,2,req,name=lcl_hostname,json=lclHostname" json:"lcl_hostname,omitempty"`
	LclIfname   *string `protobuf:"bytes,3,req,name=lcl_ifname,json=lclIfname" json:"lcl_ifname,omitempty"`
	RmtHostname *string `protobuf:"bytes,4,req,name=rmt_hostname,json=rmtHostname" json:"rmt_hostname,omitempty"`
	RmtIfname   *string `protobuf:"bytes,5,req,name=rmt_ifname,json=rmtIfname" json:"rmt_ifname,omitempty"`
	RmtSysdescr *string `protobuf:"bytes,6,req,name=rmt_sysdescr,json=rmtSysdescr" json:"rmt_sysdescr,omitempty"`
	// contains filtered or unexported fields
}

func (*CablePeerEvent) Descriptor deprecated

func (*CablePeerEvent) Descriptor() ([]byte, []int)

Deprecated: Use CablePeerEvent.ProtoReflect.Descriptor instead.

func (*CablePeerEvent) GetLclDeviceId

func (x *CablePeerEvent) GetLclDeviceId() string

func (*CablePeerEvent) GetLclHostname

func (x *CablePeerEvent) GetLclHostname() string

func (*CablePeerEvent) GetLclIfname

func (x *CablePeerEvent) GetLclIfname() string

func (*CablePeerEvent) GetRmtHostname

func (x *CablePeerEvent) GetRmtHostname() string

func (*CablePeerEvent) GetRmtIfname

func (x *CablePeerEvent) GetRmtIfname() string

func (*CablePeerEvent) GetRmtSysdescr

func (x *CablePeerEvent) GetRmtSysdescr() string

func (*CablePeerEvent) ProtoMessage

func (*CablePeerEvent) ProtoMessage()

func (*CablePeerEvent) ProtoReflect

func (x *CablePeerEvent) ProtoReflect() protoreflect.Message

func (*CablePeerEvent) Reset

func (x *CablePeerEvent) Reset()

func (*CablePeerEvent) String

func (x *CablePeerEvent) String() string

type CablePeerMismatchAlert

type CablePeerMismatchAlert struct {
	LclHostname *string `protobuf:"bytes,1,req,name=lcl_hostname,json=lclHostname" json:"lcl_hostname,omitempty"`
	LclIfname   *string `protobuf:"bytes,2,req,name=lcl_ifname,json=lclIfname" json:"lcl_ifname,omitempty"`
	ExpHostname *string `protobuf:"bytes,4,req,name=exp_hostname,json=expHostname" json:"exp_hostname,omitempty"`
	ExpIfname   *string `protobuf:"bytes,5,req,name=exp_ifname,json=expIfname" json:"exp_ifname,omitempty"`
	RmtHostname *string `protobuf:"bytes,6,req,name=rmt_hostname,json=rmtHostname" json:"rmt_hostname,omitempty"`
	RmtIfname   *string `protobuf:"bytes,7,req,name=rmt_ifname,json=rmtIfname" json:"rmt_ifname,omitempty"`
	RmtSysdescr *string `protobuf:"bytes,8,req,name=rmt_sysdescr,json=rmtSysdescr" json:"rmt_sysdescr,omitempty"`
	// contains filtered or unexported fields
}

func (*CablePeerMismatchAlert) Descriptor deprecated

func (*CablePeerMismatchAlert) Descriptor() ([]byte, []int)

Deprecated: Use CablePeerMismatchAlert.ProtoReflect.Descriptor instead.

func (*CablePeerMismatchAlert) GetExpHostname

func (x *CablePeerMismatchAlert) GetExpHostname() string

func (*CablePeerMismatchAlert) GetExpIfname

func (x *CablePeerMismatchAlert) GetExpIfname() string

func (*CablePeerMismatchAlert) GetLclHostname

func (x *CablePeerMismatchAlert) GetLclHostname() string

func (*CablePeerMismatchAlert) GetLclIfname

func (x *CablePeerMismatchAlert) GetLclIfname() string

func (*CablePeerMismatchAlert) GetRmtHostname

func (x *CablePeerMismatchAlert) GetRmtHostname() string

func (*CablePeerMismatchAlert) GetRmtIfname

func (x *CablePeerMismatchAlert) GetRmtIfname() string

func (*CablePeerMismatchAlert) GetRmtSysdescr

func (x *CablePeerMismatchAlert) GetRmtSysdescr() string

func (*CablePeerMismatchAlert) ProtoMessage

func (*CablePeerMismatchAlert) ProtoMessage()

func (*CablePeerMismatchAlert) ProtoReflect

func (x *CablePeerMismatchAlert) ProtoReflect() protoreflect.Message

func (*CablePeerMismatchAlert) Reset

func (x *CablePeerMismatchAlert) Reset()

func (*CablePeerMismatchAlert) String

func (x *CablePeerMismatchAlert) String() string
type CablingMapLink struct {
	TagLabels       []string
	Speed           LogicalDevicePortSpeed
	AggregateLinkId ObjectId
	GroupLabel      string
	Label           string
	Role            LinkRole
	Endpoints       []CablingMapLinkEndpoint
	Type            LinkType
	Id              ObjectId
}

func (*CablingMapLink) EndpointBySystemId

func (o *CablingMapLink) EndpointBySystemId(systemId ObjectId) *CablingMapLinkEndpoint

EndpointBySystemId returns the first (likely only) *CablingMapLinkEndpoint connected to the specified system.

func (*CablingMapLink) OppositeEndpointBySystemId

func (o *CablingMapLink) OppositeEndpointBySystemId(systemId ObjectId) *CablingMapLinkEndpoint

OppositeEndpointBySystemId does the opposite of EndpointBySystemId. Rather than returning the specified endpoint, it returns the other one. For "opposite" to be a useful concept, there must be exactly two endpoints. Returns nil if endpoint count isn't 2, if both ends of the link land on the specified system, or if no ends of the link end on the specified system.

type CablingMapLinkEndpoint

type CablingMapLinkEndpoint struct {
	Interface *CablingMapLinkEndpointInterface
	System    *CablingMapLinkEndpointSystem
}

func (*CablingMapLinkEndpoint) Digest

func (o *CablingMapLinkEndpoint) Digest() *string

Digest returns a string which uniquely identifies the endpoint by the system and interface where it terminates. It returns *string like "abc123:xe-0/0/1" or "def456:eth0" If any of the required elements are nil, nil is returned.

type CablingMapLinkEndpointInterface

type CablingMapLinkEndpointInterface struct {
	OperationState InterfaceOperationState
	IfName         *string
	PortChannelId  *int
	IfType         InterfaceType
	Id             ObjectId
	LagMode        RackLinkLagMode
}

type CablingMapLinkEndpointSystem

type CablingMapLinkEndpointSystem struct {
	Role  SystemNodeRole
	Id    ObjectId
	Label string
}

type Client

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

Client interacts with an AOS API server

func (*Client) ApiVersion

func (o *Client) ApiVersion() string

ApiVersion returns the version string reported by the Apstra API

func (*Client) AssignAgentProfile

func (o *Client) AssignAgentProfile(ctx context.Context, req *AssignAgentProfileRequest) error

AssignAgentProfile assigns an AgentProfile to each SystemAgent enumerated in AssignAgentProfileRequest

func (*Client) BlueprintOverlayControlProtocol

func (o *Client) BlueprintOverlayControlProtocol(ctx context.Context, id ObjectId) (OverlayControlProtocol, error)

func (*Client) CreateAgentProfile

func (o *Client) CreateAgentProfile(ctx context.Context, cfg *AgentProfileConfig) (ObjectId, error)

CreateAgentProfile creates a new Agent Profile identified by 'cfg'

func (*Client) CreateAsnPool

func (o *Client) CreateAsnPool(ctx context.Context, in *AsnPoolRequest) (ObjectId, error)

CreateAsnPool adds an ASN pool to Apstra

func (*Client) CreateBlueprintFromTemplate

func (o *Client) CreateBlueprintFromTemplate(ctx context.Context, req *CreateBlueprintFromTemplateRequest) (ObjectId, error)

CreateBlueprintFromTemplate creates a blueprint using the supplied reference design and template

func (*Client) CreateConfiglet

func (o *Client) CreateConfiglet(ctx context.Context, in *ConfigletData) (ObjectId, error)

CreateConfiglet creates a Configlet and returns its ObjectId.

func (*Client) CreateDeviceProfile

func (o *Client) CreateDeviceProfile(ctx context.Context, profile *DeviceProfileData) (ObjectId, error)

CreateDeviceProfile creates device profile

func (*Client) CreateIntegerPool

func (o *Client) CreateIntegerPool(ctx context.Context, in *IntPoolRequest) (ObjectId, error)

CreateIntegerPool adds an Integer Pool to Apstra

func (*Client) CreateInterfaceMap

func (o *Client) CreateInterfaceMap(ctx context.Context, in *InterfaceMapData) (ObjectId, error)

CreateInterfaceMap creates an interface map, returns its ObjectId

func (*Client) CreateIp4Pool

func (o *Client) CreateIp4Pool(ctx context.Context, in *NewIpPoolRequest) (ObjectId, error)

CreateIp4Pool creates an IPv4 resource pool

func (*Client) CreateIp6Pool

func (o *Client) CreateIp6Pool(ctx context.Context, in *NewIpPoolRequest) (ObjectId, error)

CreateIp6Pool creates an IPv6 resource pool

func (*Client) CreateL3CollapsedTemplate

func (o *Client) CreateL3CollapsedTemplate(ctx context.Context, in *CreateL3CollapsedTemplateRequest) (ObjectId, error)

CreateL3CollapsedTemplate creates a template based on the supplied CreateL3CollapsedTemplateRequest

func (*Client) CreateLogicalDevice

func (o *Client) CreateLogicalDevice(ctx context.Context, in *LogicalDeviceData) (ObjectId, error)

CreateLogicalDevice creates a new logical device, returns its ObjectId

func (*Client) CreateModularDeviceProfile

func (o *Client) CreateModularDeviceProfile(ctx context.Context, in *ModularDeviceProfile) (ObjectId, error)

CreateModularDeviceProfile creates a ModularDeviceProfile in Apstra based on the supplied object, and returns its ID.

func (*Client) CreatePodBasedTemplate

func (o *Client) CreatePodBasedTemplate(ctx context.Context, in *CreatePodBasedTemplateRequest) (ObjectId, error)

CreatePodBasedTemplate creates a template based on the supplied CreatePodBasedTempalteRequest

func (*Client) CreatePropertySet

func (o *Client) CreatePropertySet(ctx context.Context, in *PropertySetData) (ObjectId, error)

CreatePropertySet creates a property set with the data in PropertySetData. On success, it returns the id of the new property set that was created

func (*Client) CreateRackBasedTemplate

func (o *Client) CreateRackBasedTemplate(ctx context.Context, in *CreateRackBasedTemplateRequest) (ObjectId, error)

CreateRackBasedTemplate creates a template based on the supplied CreateRackBasedTempalteRequest

func (*Client) CreateRackType

func (o *Client) CreateRackType(ctx context.Context, request *RackTypeRequest) (ObjectId, error)

CreateRackType creates an Apstra Rack Type based on the contents of the supplied RackTypeRequest. Consistent with the Apstra UI and documentation, logical devices (switches, generic systems) and tags cloned within the rack are specified by referencing items found in the global catalog. Changes to global catalog items will not propagate into previously-created rack types.

func (*Client) CreateSystemAgent

func (o *Client) CreateSystemAgent(ctx context.Context, request *SystemAgentRequest) (ObjectId, error)

CreateSystemAgent creates an Apstra System Agent and returns its ID

func (*Client) CreateTag

func (o *Client) CreateTag(ctx context.Context, in *DesignTagRequest) (ObjectId, error)

CreateTag creates a DesignTag and returns its ObjectId. Note that the DesignTag.Label field across all tags is required to be unique and case is not considered when making that comparison.

func (*Client) CreateVniPool

func (o *Client) CreateVniPool(ctx context.Context, in *VniPoolRequest) (ObjectId, error)

CreateVniPool adds a VNI pool to Apstra

func (*Client) DeleteAgentProfile

func (o *Client) DeleteAgentProfile(ctx context.Context, id ObjectId) error

DeleteAgentProfile deletes the Agent Profile 'id'

func (*Client) DeleteAsnPool

func (o *Client) DeleteAsnPool(ctx context.Context, in ObjectId) error

DeleteAsnPool deletes an ASN pool, by ObjectId from Apstra

func (*Client) DeleteBlueprint

func (o *Client) DeleteBlueprint(ctx context.Context, id ObjectId) error

DeleteBlueprint deletes the specified blueprint

func (*Client) DeleteConfiglet

func (o *Client) DeleteConfiglet(ctx context.Context, in ObjectId) error

DeleteConfiglet deletes a configlet.

func (*Client) DeleteDeviceProfile

func (o *Client) DeleteDeviceProfile(ctx context.Context, id ObjectId) error

DeleteDeviceProfile deletes existing device profile

func (*Client) DeleteIntegerPool

func (o *Client) DeleteIntegerPool(ctx context.Context, in ObjectId) error

DeleteIntegerPool deletes an Integer Pool, by ObjectId from Apstra

func (*Client) DeleteInterfaceMap

func (o *Client) DeleteInterfaceMap(ctx context.Context, id ObjectId) error

DeleteInterfaceMap deletes the interface map identified by id

func (*Client) DeleteIp4Pool

func (o *Client) DeleteIp4Pool(ctx context.Context, id ObjectId) error

DeleteIp4Pool deletes the specified IPv4 resource pool

func (*Client) DeleteIp6Pool

func (o *Client) DeleteIp6Pool(ctx context.Context, id ObjectId) error

DeleteIp6Pool deletes the specified IPv6 resource pool

func (*Client) DeleteLogicalDevice

func (o *Client) DeleteLogicalDevice(ctx context.Context, id ObjectId) error

DeleteLogicalDevice deletes the specified logical device

func (*Client) DeleteModularDeviceProfile

func (o *Client) DeleteModularDeviceProfile(ctx context.Context, id ObjectId) error

DeleteModularDeviceProfile deletes the ModularDeviceProfile identified by id

func (*Client) DeletePropertySet

func (o *Client) DeletePropertySet(ctx context.Context, id ObjectId) error

DeletePropertySet deletes a property given the id

func (*Client) DeleteRackType

func (o *Client) DeleteRackType(ctx context.Context, id ObjectId) error

DeleteRackType deletes the rack type identified by id.

func (*Client) DeleteStreamingConfig

func (o *Client) DeleteStreamingConfig(ctx context.Context, id ObjectId) error

DeleteStreamingConfig deletes the specified streaming config / receiver from the Apstra server configuration.

func (*Client) DeleteSystem

func (o *Client) DeleteSystem(ctx context.Context, id SystemId) error

DeleteSystem deletes the specified SystemId

func (*Client) DeleteSystemAgent

func (o *Client) DeleteSystemAgent(ctx context.Context, id ObjectId) error

DeleteSystemAgent creates an Apstra Agent and returns its ID

func (*Client) DeleteTag

func (o *Client) DeleteTag(ctx context.Context, id ObjectId) error

DeleteTag deletes the specified DesignTag by its ObjectId

func (*Client) DeleteTemplate

func (o *Client) DeleteTemplate(ctx context.Context, id ObjectId) error

DeleteTemplate deletes the template specified by id

func (*Client) DeleteVniPool

func (o *Client) DeleteVniPool(ctx context.Context, in ObjectId) error

DeleteVniPool deletes a VNI pool, by ObjectId from Apstra

func (*Client) DeployBlueprint

func (o *Client) DeployBlueprint(ctx context.Context, in *BlueprintDeployRequest) (*BlueprintDeployResponse, error)

DeployBlueprint commits the staging blueprint to the active blueprint

func (*Client) GetAgentProfile

func (o *Client) GetAgentProfile(ctx context.Context, id ObjectId) (*AgentProfile, error)

GetAgentProfile returns the AgentProfile identified by 'id'

func (*Client) GetAgentProfileByLabel

func (o *Client) GetAgentProfileByLabel(ctx context.Context, label string) (*AgentProfile, error)

GetAgentProfileByLabel returns the Agent Profile with the given label. Apstra doesn't allow label collisions, so this should be a unique match. If no match, a ClientErr with Type ErrNotfound is returned.

func (*Client) GetAllAgentProfiles

func (o *Client) GetAllAgentProfiles(ctx context.Context) ([]AgentProfile, error)

GetAllAgentProfiles returns the []AgentProfileId representing all Agent Profiles

func (*Client) GetAllBlueprintStatus

func (o *Client) GetAllBlueprintStatus(ctx context.Context) ([]BlueprintStatus, error)

GetAllBlueprintStatus returns []BlueprintStatus summarizing blueprints configured on Apstra

func (*Client) GetAllConfiglets

func (o *Client) GetAllConfiglets(ctx context.Context) ([]Configlet, error)

GetAllConfiglets returns []Configlet representing all configlets

func (*Client) GetAllDeviceProfiles

func (o *Client) GetAllDeviceProfiles(ctx context.Context) ([]DeviceProfile, error)

GetAllDeviceProfiles returns []DeviceProfile

func (*Client) GetAllInterfaceMaps

func (o *Client) GetAllInterfaceMaps(ctx context.Context) ([]InterfaceMap, error)

GetAllInterfaceMaps returns []InterfaceMap representing all interface maps configured on Apstra

func (*Client) GetAllL3CollapsedTemplates

func (o *Client) GetAllL3CollapsedTemplates(ctx context.Context) ([]TemplateL3Collapsed, error)

GetAllL3CollapsedTemplates returns []TemplateL3Collapsed representing all l3_collapsed templates

func (*Client) GetAllPodBasedTemplates

func (o *Client) GetAllPodBasedTemplates(ctx context.Context) ([]TemplatePodBased, error)

GetAllPodBasedTemplates returns []TemplatePodBased representing all pod_based templates

func (*Client) GetAllPropertySets

func (o *Client) GetAllPropertySets(ctx context.Context) ([]PropertySet, error)

GetAllPropertySets returns []PropertySet representing all property sets configured on Apstra

func (*Client) GetAllRackBasedTemplates

func (o *Client) GetAllRackBasedTemplates(ctx context.Context) ([]TemplateRackBased, error)

GetAllRackBasedTemplates returns []TemplateRackBased representing all rack_based templates

func (*Client) GetAllRackTypes

func (o *Client) GetAllRackTypes(ctx context.Context) ([]RackType, error)

GetAllRackTypes returns []RackType representing all rack types configured on Apstra.

func (*Client) GetAllStreamingConfigIds

func (o *Client) GetAllStreamingConfigIds(ctx context.Context) ([]ObjectId, error)

GetAllStreamingConfigIds returns a []ObjectId representing Streaming Receivers currently known to Apstra

func (*Client) GetAllSystemAgents

func (o *Client) GetAllSystemAgents(ctx context.Context) ([]SystemAgent, error)

GetAllSystemAgents returns a SystemAgent structure representing the supplied ID

func (*Client) GetAllSystemsInfo

func (o *Client) GetAllSystemsInfo(ctx context.Context) ([]ManagedSystemInfo, error)

GetAllSystemsInfo returns []ManagedSystemInfo representing all systems configured on the Apstra server.

func (*Client) GetAllTags

func (o *Client) GetAllTags(ctx context.Context) ([]DesignTag, error)

GetAllTags returns []DesignTag describing all DesignTag objects

func (*Client) GetAllTemplates

func (o *Client) GetAllTemplates(ctx context.Context) ([]Template, error)

GetAllTemplates returns []Template where each element is one of these:

TemplateRackBased
TemplatePodBased
TemplateL3Collapsed

func (*Client) GetAnomalies

func (o *Client) GetAnomalies(ctx context.Context) ([]Anomaly, error)

GetAnomalies is limited to 10k response items // todo: pagination?

func (*Client) GetAsnPool

func (o *Client) GetAsnPool(ctx context.Context, in ObjectId) (*AsnPool, error)

GetAsnPool returns, by ObjectId, a specific ASN pool

func (*Client) GetAsnPoolByName

func (o *Client) GetAsnPoolByName(ctx context.Context, desired string) (*AsnPool, error)

GetAsnPoolByName returns ASN pools configured on Apstra

func (*Client) GetAsnPools

func (o *Client) GetAsnPools(ctx context.Context) ([]AsnPool, error)

GetAsnPools returns ASN pools configured on Apstra

func (*Client) GetAuditConfig

func (o *Client) GetAuditConfig(ctx context.Context) (*AuditConfig, error)

GetAuditConfig returns current Audit Configuration as *AuditConfig

func (*Client) GetBlueprint

func (o *Client) GetBlueprint(ctx context.Context, in ObjectId) (*Blueprint, error)

GetBlueprint returns *Blueprint detailing the requested blueprint

func (*Client) GetBlueprintAnomalies

func (o *Client) GetBlueprintAnomalies(ctx context.Context, blueprintId ObjectId) ([]BlueprintAnomaly, error)

GetBlueprintAnomalies returns []BlueprintAnomaly representing all anomalies in the blueprint.

func (*Client) GetBlueprintNodeAnomalyCounts

func (o *Client) GetBlueprintNodeAnomalyCounts(ctx context.Context, blueprintId ObjectId) ([]BlueprintNodeAnomalyCounts, error)

GetBlueprintNodeAnomalyCounts returns []BlueprintNodeAnomalyCounts which summarize current anomalies on a per-node basis in the blueprint. Nodes which are not currently experiencing an anomaly are not represented in the returned slice.

func (*Client) GetBlueprintServiceAnomalyCounts

func (o *Client) GetBlueprintServiceAnomalyCounts(ctx context.Context, blueprintId ObjectId) ([]BlueprintServiceAnomalyCount, error)

GetBlueprintServiceAnomalyCounts returns []BlueprintServiceAnomalyCount which summarize current anomalies on a per-service basis in the blueprint. Services which are not currently experiencing an anomaly are not represented in the returned slice.

func (*Client) GetBlueprintStatus

func (o *Client) GetBlueprintStatus(ctx context.Context, id ObjectId) (*BlueprintStatus, error)

GetBlueprintStatus returns *BlueprintStatus for the specified blueprint ID

func (*Client) GetBlueprintStatusByName

func (o *Client) GetBlueprintStatusByName(ctx context.Context, name string) (*BlueprintStatus, error)

GetBlueprintStatusByName returns *BlueprintStatus for the specified blueprint name

func (*Client) GetConfiglet

func (o *Client) GetConfiglet(ctx context.Context, in ObjectId) (*Configlet, error)

GetConfiglet Accepts an ID and returns the Configlet object

func (*Client) GetConfigletByName

func (o *Client) GetConfigletByName(ctx context.Context, Name string) (*Configlet, error)

GetConfigletByName gets a configlet by Name

func (*Client) GetDeviceProfile

func (o *Client) GetDeviceProfile(ctx context.Context, id ObjectId) (*DeviceProfile, error)

GetDeviceProfile returns device profile

func (*Client) GetDeviceProfileByName

func (o *Client) GetDeviceProfileByName(ctx context.Context, desired string) (*DeviceProfile, error)

GetDeviceProfileByName returns *DeviceProfile indicating the device profile which uses the desired name, or an error if 0 or > 1 device profiles match.

func (*Client) GetDeviceProfilesByName

func (o *Client) GetDeviceProfilesByName(ctx context.Context, desired string) ([]DeviceProfile, error)

GetDeviceProfilesByName returns []DeviceProfile including all profiles using the desired name

func (*Client) GetIntegerPool

func (o *Client) GetIntegerPool(ctx context.Context, in ObjectId) (*IntPool, error)

GetIntegerPool returns, by ObjectId, a specific Integer Pool

func (*Client) GetIntegerPoolByName

func (o *Client) GetIntegerPoolByName(ctx context.Context, desired string) (*IntPool, error)

GetIntegerPoolByName returns Integer Pools configured on Apstra

func (*Client) GetIntegerPools

func (o *Client) GetIntegerPools(ctx context.Context) ([]IntPool, error)

GetIntegerPools returns Integer Pools configured on Apstra

func (*Client) GetInterfaceMap

func (o *Client) GetInterfaceMap(ctx context.Context, id ObjectId) (*InterfaceMap, error)

GetInterfaceMap returns *InterfaceMap representing the interface map identified by id

func (*Client) GetInterfaceMapByName

func (o *Client) GetInterfaceMapByName(ctx context.Context, desired string) (*InterfaceMap, error)

GetInterfaceMapByName returns *Interface map where exactly one interface map uses the desired name.

func (*Client) GetInterfaceMapDigest

func (o *Client) GetInterfaceMapDigest(ctx context.Context, id ObjectId) (*InterfaceMapDigest, error)

GetInterfaceMapDigest returns *InterfaceMapDigest representing the supplied ObjectId

func (*Client) GetInterfaceMapDigests

func (o *Client) GetInterfaceMapDigests(ctx context.Context) (InterfaceMapDigests, error)

GetInterfaceMapDigests returns InterfaceMapDigests representing all interface maps

func (*Client) GetInterfaceMapDigestsByDeviceProfile

func (o *Client) GetInterfaceMapDigestsByDeviceProfile(ctx context.Context, desired ObjectId) (InterfaceMapDigests, error)

GetInterfaceMapDigestsByDeviceProfile returns InterfaceMapDigests representing all interface maps which reference the desired DeviceProfile ID

func (*Client) GetInterfaceMapDigestsByLogicalDevice

func (o *Client) GetInterfaceMapDigestsByLogicalDevice(ctx context.Context, desired ObjectId) (InterfaceMapDigests, error)

GetInterfaceMapDigestsByLogicalDevice returns InterfaceMapDigests representing all interface maps which reference the desired LogicalDevice ID

func (*Client) GetInterfaceMapDigestsLogicalDeviceAndDeviceProfile

func (o *Client) GetInterfaceMapDigestsLogicalDeviceAndDeviceProfile(ctx context.Context, ldId ObjectId, dpId ObjectId) (InterfaceMapDigests, error)

GetInterfaceMapDigestsLogicalDeviceAndDeviceProfile returns InterfaceMapDigests representing all interface maps which reference the desired LogicalDevice ID and DeviceProfile ID

func (*Client) GetIp4Pool

func (o *Client) GetIp4Pool(ctx context.Context, poolId ObjectId) (*IpPool, error)

GetIp4Pool returns an IPv4 resource pool

func (*Client) GetIp4PoolByName

func (o *Client) GetIp4PoolByName(ctx context.Context, desiredName string) (*IpPool, error)

GetIp4PoolByName returns an IPv4 resource pool

func (*Client) GetIp4Pools

func (o *Client) GetIp4Pools(ctx context.Context) ([]IpPool, error)

GetIp4Pools returns all IPv4 pools configured on Apstra

func (*Client) GetIp6Pool

func (o *Client) GetIp6Pool(ctx context.Context, poolId ObjectId) (*IpPool, error)

GetIp6Pool returns an IPv6 resource pool

func (*Client) GetIp6PoolByName

func (o *Client) GetIp6PoolByName(ctx context.Context, desiredName string) (*IpPool, error)

GetIp6PoolByName returns an IPv6 resource pool

func (*Client) GetIp6Pools

func (o *Client) GetIp6Pools(ctx context.Context) ([]IpPool, error)

GetIp6Pools returns all IPv6 pools configured on Apstra

func (*Client) GetL3CollapsedTemplate

func (o *Client) GetL3CollapsedTemplate(ctx context.Context, id ObjectId) (*TemplateL3Collapsed, error)

GetL3CollapsedTemplate returns *TemplateL3Collapsed represented by `id`

func (*Client) GetL3CollapsedTemplateByName

func (o *Client) GetL3CollapsedTemplateByName(ctx context.Context, name string) (*TemplateL3Collapsed, error)

GetL3CollapsedTemplateByName returns *L3CollapsedTemplate if exactly one pod_based template uses the specified name. If zero templates or more than one template uses the name, an error is returned.

func (*Client) GetLastDeployedRevision

func (o *Client) GetLastDeployedRevision(ctx context.Context, id ObjectId) (*BlueprintRevision, error)

GetLastDeployedRevision returns *BlueprintRevision representing the most recent deployment of blueprint 'id'

func (*Client) GetLogicalDevice

func (o *Client) GetLogicalDevice(ctx context.Context, id ObjectId) (*LogicalDevice, error)

GetLogicalDevice returns the requested *LogicalDevice

func (*Client) GetLogicalDeviceByName

func (o *Client) GetLogicalDeviceByName(ctx context.Context, name string) (*LogicalDevice, error)

GetLogicalDeviceByName returns *LogicalDevice matching name if exactly one logical device uses that name. No match or multiple match conditions produce and error.

func (*Client) GetMetricdbMetrics

func (o *Client) GetMetricdbMetrics(ctx context.Context) ([]MetricdbMetric, error)

GetMetricdbMetrics returns []MetricdbMetric representing the various metricdb application/namespace/name paths available to be queried from Apstra

func (*Client) GetModularDeviceProfile

func (o *Client) GetModularDeviceProfile(ctx context.Context, id ObjectId) (*ModularDeviceProfile, error)

GetModularDeviceProfile returns *ModularDeviceProfile found in Apstra with the supplied ID.

func (*Client) GetNode

func (o *Client) GetNode(ctx context.Context, blueprint ObjectId, nodeId ObjectId, target interface{}) error

GetNode fetches the specified node and unpacks it into target

func (*Client) GetNodes

func (o *Client) GetNodes(ctx context.Context, blueprint ObjectId, nodeType NodeType, response interface{}) error

GetNodes fetches the node of the specified type, unpacks the API response into 'response'

func (*Client) GetPodBasedTemplate

func (o *Client) GetPodBasedTemplate(ctx context.Context, id ObjectId) (*TemplatePodBased, error)

GetPodBasedTemplate returns *TemplatePodBased represented by `id`

func (*Client) GetPodBasedTemplateByName

func (o *Client) GetPodBasedTemplateByName(ctx context.Context, name string) (*TemplatePodBased, error)

GetPodBasedTemplateByName returns *PodBasedTemplate if exactly one pod_based template uses the specified name. If zero templates or more than one template uses the name, an error is returned.

func (*Client) GetPropertySet

func (o *Client) GetPropertySet(ctx context.Context, id ObjectId) (*PropertySet, error)

GetPropertySet returns *PropertySet representing the property set with the given ID

func (*Client) GetPropertySetByLabel

func (o *Client) GetPropertySetByLabel(ctx context.Context, in string) (*PropertySet, error)

GetPropertySetByLabel returns *PropertySet representing the only property set with the given label, or an error if multiple property sets share the label.

func (*Client) GetRackBasedTemplate

func (o *Client) GetRackBasedTemplate(ctx context.Context, id ObjectId) (*TemplateRackBased, error)

GetRackBasedTemplate returns *TemplateRackBased represented by `id`

func (*Client) GetRackBasedTemplateByName

func (o *Client) GetRackBasedTemplateByName(ctx context.Context, name string) (*TemplateRackBased, error)

GetRackBasedTemplateByName returns *RackBasedTemplate if exactly one pod_based template uses the specified name. If zero templates or more than one template uses the name, an error is returned.

func (*Client) GetRackType

func (o *Client) GetRackType(ctx context.Context, id ObjectId) (*RackType, error)

GetRackType returns *RackType detailing the rack type identified by id.

func (*Client) GetRackTypeByName

func (o *Client) GetRackTypeByName(ctx context.Context, name string) (*RackType, error)

GetRackTypeByName returns *RackType detailing the rack type identified by name.

func (*Client) GetRevision

func (o *Client) GetRevision(ctx context.Context, id ObjectId, rev int) (*BlueprintRevision, error)

GetRevision returns *BlueprintRevision representing a specific recent blueprint revision number 'rev' of blueprint 'id'

func (*Client) GetRevisions

func (o *Client) GetRevisions(ctx context.Context, id ObjectId) ([]BlueprintRevision, error)

GetRevisions returns []BlueprintRevision of blueprint 'id' representing recent revisions available for rollback

func (*Client) GetStreamingConfig

func (o *Client) GetStreamingConfig(ctx context.Context, id ObjectId) (*StreamingConfigInfo, error)

GetStreamingConfig returns a slice of *StreamingConfigInfo representing the requested Apstra streaming configs / receivers

func (*Client) GetStreamingConfigIDByCfg

func (o *Client) GetStreamingConfigIDByCfg(ctx context.Context, in *StreamingConfigParams) (ObjectId, error)

GetStreamingConfigIDByCfg checks current StreamingConfigs (Streaming Receivers) against the supplied StreamingConfigInfo. If the stream seems to already exist on the AOS server, the returned ObjectId will be populated. If not found, it will be empty.

func (*Client) GetSystemAgent

func (o *Client) GetSystemAgent(ctx context.Context, id ObjectId) (*SystemAgent, error)

GetSystemAgent returns a SystemAgent structure representing the supplied ID

func (*Client) GetSystemAgentByManagementIp

func (o *Client) GetSystemAgentByManagementIp(ctx context.Context, ip string) (*SystemAgent, error)

GetSystemAgentByManagementIp returns *SystemAgent representing the Agent with the given "Management Ip" (which in Apstra terms can also be a hostname). Apstra doesn't allow management IP collisions, so this should be a unique match. If no match, a ClientErr with type ErrNotfound is returned.

func (*Client) GetSystemAgentJobHistory

func (o *Client) GetSystemAgentJobHistory(ctx context.Context, id ObjectId) ([]AgentJobStatus, error)

GetSystemAgentJobHistory returns []AgentJobStatus representing all jobs executed by the agent

func (*Client) GetSystemAgentJobStatus

func (o *Client) GetSystemAgentJobStatus(ctx context.Context, agentId ObjectId, jobId JobId) (*AgentJobStatus, error)

GetSystemAgentJobStatus returns *AgentJobStatus for the given agent and job

func (*Client) GetSystemAgentManagerConfig

func (o *Client) GetSystemAgentManagerConfig(ctx context.Context) (*SystemAgentManagerConfig, error)

GetSystemAgentManagerConfig returns *SystemAgentManagerConfig representing the Advanced Settings found on the Managed Devices page of the Web UI.

func (*Client) GetSystemConfig

func (o *Client) GetSystemConfig(ctx context.Context, id ObjectId) (SystemConfig, error)

GetSystemConfig returns a SystemConfig for id (the device_key / serial number of a managed device).

func (*Client) GetSystemInfo

func (o *Client) GetSystemInfo(ctx context.Context, id SystemId) (*ManagedSystemInfo, error)

GetSystemInfo returns a *ManagedSystemInfo representing the requested SystemId

func (*Client) GetTag

func (o *Client) GetTag(ctx context.Context, id ObjectId) (*DesignTag, error)

GetTag returns *DesignTag describing the specified ObjectId

func (*Client) GetTagByLabel

func (o *Client) GetTagByLabel(ctx context.Context, label string) (*DesignTag, error)

GetTagByLabel returns a *DesignTag matching the supplied DesignTag.Label string ("Name" in the web UI). This is a case-sensitive search even though apstra enforces uniqueness in a case-insensitive manner. An error is returned if no DesignTag objects match the supplied DesignTag.Label.

func (*Client) GetTagsByLabels

func (o *Client) GetTagsByLabels(ctx context.Context, labels []string) ([]DesignTag, error)

GetTagsByLabels returns []DesignTag matching the supplied slice of labels which may not contain duplicates. If any tag does not exist, an error is returned.

func (*Client) GetTelemetryServicesDeviceMapping

func (o *Client) GetTelemetryServicesDeviceMapping(ctx context.Context) (*GetTelemetryServiceMappingResult, error)

func (*Client) GetTemplateIdTypeByName

func (o *Client) GetTemplateIdTypeByName(ctx context.Context, desired string) (ObjectId, TemplateType, error)

GetTemplateIdTypeByName returns the ObjectId and TemplateType of the single template in the apstra global catalog which uses the name 'desired'. If zero templates or more than 1 templates use the name, an error is returned.

func (*Client) GetTemplateIdsTypesByName

func (o *Client) GetTemplateIdsTypesByName(ctx context.Context, desired string) (map[ObjectId]TemplateType, error)

GetTemplateIdsTypesByName returns map[ObjectId]TemplateType including all templates with the desired name found in the apstra global catalog.

func (*Client) GetTemplateType

func (o *Client) GetTemplateType(ctx context.Context, id ObjectId) (TemplateType, error)

GetTemplateType returns the TemplateType of the template known by id

func (*Client) GetVersion

func (o *Client) GetVersion(ctx context.Context) (*VersionResponse, error)

GetVersion calls apiUrlVersion, returns the Apstra server version as a VersionResponse

func (*Client) GetVirtualInfraMgrs

func (o *Client) GetVirtualInfraMgrs(ctx context.Context) ([]VirtualInfraMgrInfo, error)

GetVirtualInfraMgrs returns all Virtual Infrastructure Managers configured in Apstra

func (*Client) GetVniPool

func (o *Client) GetVniPool(ctx context.Context, in ObjectId) (*VniPool, error)

GetVniPool returns, by ObjectId, a specific Vni pool

func (*Client) GetVniPoolByName

func (o *Client) GetVniPoolByName(ctx context.Context, name string) (*VniPool, error)

GetVniPoolByName returns *VniPool for the specified VNI pool name

func (*Client) GetVniPools

func (o *Client) GetVniPools(ctx context.Context) ([]VniPool, error)

GetVniPools returns Vni pools configured on Apstra

func (*Client) ID

func (o *Client) ID() ObjectId

ID returns the Apstra User ID associated with the client or an empty string if not logged in.

func (*Client) ListAgentProfileIds

func (o *Client) ListAgentProfileIds(ctx context.Context) ([]ObjectId, error)

ListAgentProfileIds returns a []ObjectId representing Agent Profiles

func (*Client) ListAllBlueprintIds

func (o *Client) ListAllBlueprintIds(ctx context.Context) ([]ObjectId, error)

ListAllBlueprintIds returns []ObjectId representing all blueprints

func (*Client) ListAllConfiglets

func (o *Client) ListAllConfiglets(ctx context.Context) ([]ObjectId, error)

ListAllConfiglets gets the List of All configlet IDs

func (*Client) ListAllInterfaceMapIds

func (o *Client) ListAllInterfaceMapIds(ctx context.Context) ([]ObjectId, error)

ListAllInterfaceMapIds returns []ObjectId representing all interface maps

func (*Client) ListAllPropertySets

func (o *Client) ListAllPropertySets(ctx context.Context) ([]ObjectId, error)

ListAllPropertySets returns []ObjectId representing all property sets configured on Apstra

func (*Client) ListAllTags

func (o *Client) ListAllTags(ctx context.Context) ([]ObjectId, error)

ListAllTags returns []ObjectId representing all DesignTag objects

func (*Client) ListAllTemplateIds

func (o *Client) ListAllTemplateIds(ctx context.Context) ([]ObjectId, error)

ListAllTemplateIds returns []ObjectId representing all blueprint templates

func (*Client) ListAsnPoolIds

func (o *Client) ListAsnPoolIds(ctx context.Context) ([]ObjectId, error)

ListAsnPoolIds returns ASN pools configured on Apstra

func (*Client) ListIntegerPoolIds

func (o *Client) ListIntegerPoolIds(ctx context.Context) ([]ObjectId, error)

ListIntegerPoolIds returns Integer Pools configured on Apstra

func (*Client) ListIp4PoolIds

func (o *Client) ListIp4PoolIds(ctx context.Context) ([]ObjectId, error)

ListIp4PoolIds returns []ObjectId representing all IPv4 resource pools

func (*Client) ListIp6PoolIds

func (o *Client) ListIp6PoolIds(ctx context.Context) ([]ObjectId, error)

ListIp6PoolIds returns []ObjectId representing all IPv6 resource pools

func (*Client) ListLogicalDeviceIds

func (o *Client) ListLogicalDeviceIds(ctx context.Context) ([]ObjectId, error)

ListLogicalDeviceIds returns a list of logical device IDs configured in Apstra

func (*Client) ListRackTypeIds

func (o *Client) ListRackTypeIds(ctx context.Context) ([]ObjectId, error)

ListRackTypeIds returns a []ObjectId representing all rack types configured on Apstra.

func (*Client) ListSystemAgents

func (o *Client) ListSystemAgents(ctx context.Context) ([]ObjectId, error)

ListSystemAgents returns []ObjectId representing all Managed Device System Agents

func (*Client) ListSystems

func (o *Client) ListSystems(ctx context.Context) ([]SystemId, error)

ListSystems returns []SystemId representing systems configured on the Apstra server.

func (*Client) ListVniPoolIds

func (o *Client) ListVniPoolIds(ctx context.Context) ([]ObjectId, error)

ListVniPoolIds returns Vni pools configured on Apstra

func (*Client) Log

func (o *Client) Log(msgLevel int, msg string)

Log causes the message to be logged according to the policy for the selected msgLevel

func (*Client) Logf

func (o *Client) Logf(msgLevel int, msg string, a ...any)

Logf causes the message to be logged according to the policy for the selected msgLevel

func (*Client) Login

func (o *Client) Login(ctx context.Context) error

Login submits username and password from the ClientCfg (Client.cfg) to the Apstra API, retrieves an authorization token. It is optional. If the client is not already logged in, Apstra will send HTTP 401. The client will log itself in and resubmit the request.

func (*Client) Logout

func (o *Client) Logout(ctx context.Context) error

Logout invalidates the Apstra API token held by Client

func (*Client) NewStreamingConfig

func (o *Client) NewStreamingConfig(ctx context.Context, cfg *StreamingConfigParams) (ObjectId, error)

NewStreamingConfig creates a StreamingConfig (Streaming Receiver) on the Apstra server.

func (*Client) NewTwoStageL3ClosClient

func (o *Client) NewTwoStageL3ClosClient(ctx context.Context, blueprintId ObjectId) (*TwoStageL3ClosClient, error)

func (*Client) PatchNode

func (o *Client) PatchNode(ctx context.Context, blueprint ObjectId, node ObjectId, request interface{}, response interface{}) error

PatchNode patches (only submitted fields are changed) the specified node using the contents of 'request', the server's response (whole node info without map wrapper?) is returned in 'response'

func (*Client) PatchNodes

func (o *Client) PatchNodes(ctx context.Context, blueprint ObjectId, request []interface{}) error

PatchNodes patches (only submitted fields are changed) nodes described using the contents of 'request'.

func (*Client) PutAuditConfig

func (o *Client) PutAuditConfig(ctx context.Context, cfg *AuditConfig) error

PutAuditConfig sets Audit Configuration according to passed *AuditConfig

func (*Client) QueryMetricdb

func (o *Client) QueryMetricdb(ctx context.Context, q *MetricDbQueryRequest) (*MetricDbQueryResponse, error)

QueryMetricdb returns a MetricDbQueryResponse including all available data for the metric and time range specified in the

func (*Client) Ready

func (o *Client) Ready(ctx context.Context) error

Ready returns an error if the Apstra service isn't ready to go

func (*Client) ServerName

func (o *Client) ServerName() string

ServerName returns the hostname (or IP address string) by which the client knows the Apstra server. It's mostly useful when setting up streaming event receivers.

func (*Client) SetContext

func (o *Client) SetContext(ctx context.Context)

SetContext sets the internal context.Context used by background pollers. This context should not have a timeout/deadline, but can be used to cancel background tasks.

func (*Client) SetSystemAgentManagerConfig

func (o *Client) SetSystemAgentManagerConfig(ctx context.Context, cfg *SystemAgentManagerConfig) error

SetSystemAgentManagerConfig uses a *SystemAgentManagerConfig object to configure the Advanced Settings found on the Managed Devices page of the Web UI.

func (*Client) SystemAgentRunJob

func (o *Client) SystemAgentRunJob(ctx context.Context, agentId ObjectId, jobType AgentJobType) (*AgentJobStatus, error)

SystemAgentRunJob requests a job be started on the Agent, returns the resulting JobId

func (*Client) UpdateAgentProfile

func (o *Client) UpdateAgentProfile(ctx context.Context, id ObjectId, cfg *AgentProfileConfig) error

UpdateAgentProfile updates an Agent Profile identified by 'cfg'

func (*Client) UpdateAsnPool

func (o *Client) UpdateAsnPool(ctx context.Context, id ObjectId, cfg *AsnPoolRequest) error

UpdateAsnPool updates an ASN pool by ObjectId with new ASN pool config

func (*Client) UpdateConfiglet

func (o *Client) UpdateConfiglet(ctx context.Context, id ObjectId, in *ConfigletData) error

UpdateConfiglet updates a configlet

func (*Client) UpdateDeviceProfile

func (o *Client) UpdateDeviceProfile(ctx context.Context, id ObjectId, profile *DeviceProfileData) error

UpdateDeviceProfile updates existing device profile

func (*Client) UpdateIntegerPool

func (o *Client) UpdateIntegerPool(ctx context.Context, id ObjectId, cfg *IntPoolRequest) error

UpdateIntegerPool updates an Integer Pool by ObjectId with new Integer Pool config

func (*Client) UpdateInterfaceMap

func (o *Client) UpdateInterfaceMap(ctx context.Context, id ObjectId, ifMap *InterfaceMapData) error

UpdateInterfaceMap updates the interface map represented by id, with the details in ifMap

func (*Client) UpdateIp4Pool

func (o *Client) UpdateIp4Pool(ctx context.Context, poolId ObjectId, request *NewIpPoolRequest) error

UpdateIp4Pool updates (full replace) an existing IPv4 address pool using a NewIpPoolRequest object

func (*Client) UpdateIp6Pool

func (o *Client) UpdateIp6Pool(ctx context.Context, poolId ObjectId, request *NewIpPoolRequest) error

UpdateIp6Pool updates (full replace) an existing IPv6 address pool using a NewIpPoolRequest object

func (*Client) UpdateL3CollapsedTemplate

func (o *Client) UpdateL3CollapsedTemplate(ctx context.Context, id ObjectId, in *CreateL3CollapsedTemplateRequest) error

UpdateL3CollapsedTemplate updates a template based on the supplied CreatePodBasedTempalteRequest

func (*Client) UpdateLogicalDevice

func (o *Client) UpdateLogicalDevice(ctx context.Context, id ObjectId, in *LogicalDeviceData) error

UpdateLogicalDevice replaces the whole logical device configuration specified by id with the supplied details.

func (*Client) UpdateManagedDevice

func (o *Client) UpdateManagedDevice(ctx context.Context, id SystemId, cfg *SystemUserConfig) error

UpdateManagedDevice sets the UserConfig info for a managed system

func (*Client) UpdateManagedDeviceByAgentId

func (o *Client) UpdateManagedDeviceByAgentId(ctx context.Context, id ObjectId, cfg *SystemUserConfig) error

UpdateManagedDeviceByAgentId sets the UserConfig info for a managed system

func (*Client) UpdateModularDeviceProfile

func (o *Client) UpdateModularDeviceProfile(ctx context.Context, id ObjectId, cfg *ModularDeviceProfile) error

UpdateModularDeviceProfile updates a ModularDeviceProfile identified by id using the supplied ModularDeviceProfile.

func (*Client) UpdatePodBasedTemplate

func (o *Client) UpdatePodBasedTemplate(ctx context.Context, id ObjectId, in *CreatePodBasedTemplateRequest) error

UpdatePodBasedTemplate updates a template based on the supplied CreatePodBasedTempalteRequest

func (*Client) UpdatePropertySet

func (o *Client) UpdatePropertySet(ctx context.Context, id ObjectId, in *PropertySetData) error

UpdatePropertySet updates a property set identified by an id with the new set of data

func (*Client) UpdateRackBasedTemplate

func (o *Client) UpdateRackBasedTemplate(ctx context.Context, id ObjectId, in *CreateRackBasedTemplateRequest) error

UpdateRackBasedTemplate updates a template based on the supplied CreateRackBasedTempalteRequest

func (*Client) UpdateRackType

func (o *Client) UpdateRackType(ctx context.Context, id ObjectId, request *RackTypeRequest) error

UpdateRackType updates the Apstra Rack Type identified by id, based on the contents of the supplied RackTypeRequest. Consistent with the Apstra UI and documentation, logical devices (switches, generic systems) and tags cloned within the rack are specified by referencing items found in the global catalog. Changes to global catalog items will not propagate into previously-created rack types.

func (*Client) UpdateSystem

func (o *Client) UpdateSystem(ctx context.Context, id SystemId, cfg *SystemUserConfig) error

UpdateSystem deletes the supplied SystemId

func (*Client) UpdateSystemAgent

func (o *Client) UpdateSystemAgent(ctx context.Context, id ObjectId, request *SystemAgentRequest) error

UpdateSystemAgent creates an Apstra Agent and returns its ID

func (*Client) UpdateTag

func (o *Client) UpdateTag(ctx context.Context, id ObjectId, in *DesignTagRequest) error

UpdateTag updates a DesignTag by ObjectId. Note that the DesignTag.Label is required, but cannot be changed, so it's really just DesignTag.Description that we're allowed to monkey around with.

func (*Client) UpdateVniPool

func (o *Client) UpdateVniPool(ctx context.Context, id ObjectId, cfg *VniPoolRequest) error

UpdateVniPool updates a VNI pool by ObjectId with new Vni pool config

func (*Client) WaitUntilReady

func (o *Client) WaitUntilReady(ctx context.Context) error

WaitUntilReady blocks until the Apstra service is ready to go, the context is cancelled, or a non-retryable error occurs.

type ClientCfg

type ClientCfg struct {
	Url          string        // URL to access Apstra
	User         string        // Apstra API/UI username
	Pass         string        // Apstra API/UI password
	LogLevel     int           // set < 0 for no logging
	Logger       Logger        // optional caller-created logger sorted by increasing verbosity
	HttpClient   *http.Client  // optional
	Timeout      time.Duration // <0 = infinite; 0 = DefaultTimeout; >0 = this value is used
	ErrChan      chan<- error  // async client errors (apstra task polling, etc) sent here
	Experimental bool          // used to enable experimental features
	UserAgent    string        // may used to set a custom user-agent
}

ClientCfg is passed to NewClient() when instantiating a new apstra Client. Scheme, Host, Port, User(name) and Pass(word) describe the Apstra API. Each of these can be set by environment variable, the names of which are controlled by these constants: EnvApstraScheme, EnvApstraUser, EnvApstraPass, EnvApstraHost and EnvApstraPort. If Logger is nil, the Client will log to log.Default(). LogLevel controls log verbosity. 0 is default logging level, higher values produce more detailed logs. Negative values disable logging. HttpClient is optional. Timeout is used to create a contextWithTimeout for any passed contexts which do not expire. negative values == infinite timeout, 0/default uses DefaultTimeout value, positive values are used directly. ErrChan, when not nil, is used by async operations to deliver any errors to the caller's code.

func (ClientCfg) NewClient

func (o ClientCfg) NewClient(ctx context.Context) (*Client, error)

NewClient creates a Client object

type ClientErr

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

func (ClientErr) Detail

func (o ClientErr) Detail() interface{}

func (ClientErr) Error

func (o ClientErr) Error() string

func (ClientErr) IsRetryable

func (o ClientErr) IsRetryable() bool

func (ClientErr) Type

func (o ClientErr) Type() int

type ConfigDeviationAlert

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

func (*ConfigDeviationAlert) Descriptor deprecated

func (*ConfigDeviationAlert) Descriptor() ([]byte, []int)

Deprecated: Use ConfigDeviationAlert.ProtoReflect.Descriptor instead.

func (*ConfigDeviationAlert) ProtoMessage

func (*ConfigDeviationAlert) ProtoMessage()

func (*ConfigDeviationAlert) ProtoReflect

func (x *ConfigDeviationAlert) ProtoReflect() protoreflect.Message

func (*ConfigDeviationAlert) Reset

func (x *ConfigDeviationAlert) Reset()

func (*ConfigDeviationAlert) String

func (x *ConfigDeviationAlert) String() string

type ConfigMismatchAlert

type ConfigMismatchAlert struct {
	BlueprintId *string `protobuf:"bytes,1,req,name=blueprint_id,json=blueprintId" json:"blueprint_id,omitempty"`
	CollectorId *string `protobuf:"bytes,2,req,name=collector_id,json=collectorId" json:"collector_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigMismatchAlert) Descriptor deprecated

func (*ConfigMismatchAlert) Descriptor() ([]byte, []int)

Deprecated: Use ConfigMismatchAlert.ProtoReflect.Descriptor instead.

func (*ConfigMismatchAlert) GetBlueprintId

func (x *ConfigMismatchAlert) GetBlueprintId() string

func (*ConfigMismatchAlert) GetCollectorId

func (x *ConfigMismatchAlert) GetCollectorId() string

func (*ConfigMismatchAlert) ProtoMessage

func (*ConfigMismatchAlert) ProtoMessage()

func (*ConfigMismatchAlert) ProtoReflect

func (x *ConfigMismatchAlert) ProtoReflect() protoreflect.Message

func (*ConfigMismatchAlert) Reset

func (x *ConfigMismatchAlert) Reset()

func (*ConfigMismatchAlert) String

func (x *ConfigMismatchAlert) String() string

type Configlet

type Configlet struct {
	Id             ObjectId
	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *ConfigletData
}

type ConfigletData

type ConfigletData struct {
	RefArchs    []RefDesign
	Generators  []ConfigletGenerator
	DisplayName string
}

type ConfigletGenerator

type ConfigletGenerator struct {
	ConfigStyle          PlatformOS
	Section              ConfigletSection
	TemplateText         string
	NegationTemplateText string
	Filename             string
}

type ConfigletSection

type ConfigletSection int

func AllConfigletSections

func AllConfigletSections() []ConfigletSection

AllConfigletSections returns the []ConfigletSection representing each supported ConfigletSection

func (*ConfigletSection) FromString

func (o *ConfigletSection) FromString(s string) error

func (ConfigletSection) Int

func (o ConfigletSection) Int() int

func (ConfigletSection) String

func (o ConfigletSection) String() string

type ConnectivityTemplate

type ConnectivityTemplate struct {
	Id          *ObjectId
	Label       string
	Description string
	Subpolicies []*ConnectivityTemplatePrimitive // batch pointers
	Tags        []string
	UserData    *ConnectivityTemplatePrimitiveUserData
}

func (*ConnectivityTemplate) SetIds

func (o *ConnectivityTemplate) SetIds() error

SetIds walks the Connectivity Template tree and sets all "batch", "pipeline" and "actual" object IDs which aren't set, but need to be. Batch IDs where no children exist will not be set.

func (*ConnectivityTemplate) SetUserData

func (o *ConnectivityTemplate) SetUserData() error

SetUserData builds the top level `user_data` struct. It tries to lay the primitive "sausages" out sensibly.

type ConnectivityTemplatePrimitive

type ConnectivityTemplatePrimitive struct {
	Id          *ObjectId
	Label       string
	Attributes  ConnectivityTemplatePrimitiveAttributes
	Subpolicies []*ConnectivityTemplatePrimitive // batch of pointers to pipelines
	BatchId     *ObjectId
	PipelineId  *ObjectId
}

type ConnectivityTemplatePrimitiveAttributes

type ConnectivityTemplatePrimitiveAttributes interface {
	Description() string
	PolicyTypeName() CtPrimitivePolicyTypeName
	// contains filtered or unexported methods
}

ConnectivityTemplatePrimitiveAttributes are the data structures which make the various CT primitives (single VLAN, multiple VLAN, static route, etc...) different from each other. In Apstra 4.1.2 there are 10 CT primitives, so there are 10 implementations of the ConnectivityTemplatePrimitiveAttributes interface.

type ConnectivityTemplatePrimitiveAttributesAttachBgpOverSubinterfacesOrSvi

type ConnectivityTemplatePrimitiveAttributesAttachBgpOverSubinterfacesOrSvi struct {
	Label                 string
	Bfd                   bool
	Holdtime              *uint16
	Ipv4Safi              bool
	Ipv6Safi              bool
	Keepalive             *uint16
	LocalAsn              *uint32
	NeighborAsnDynamic    bool // 'static', 'dynamic'
	Password              *string
	PeerFromLoopback      bool
	PeerTo                CtPrimitiveBgpPeerTo
	SessionAddressingIpv4 CtPrimitiveIPv4ProtocolSessionAddressing
	SessionAddressingIpv6 CtPrimitiveIPv6ProtocolSessionAddressing
	Ttl                   uint8
}

func (*ConnectivityTemplatePrimitiveAttributesAttachBgpOverSubinterfacesOrSvi) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachBgpOverSubinterfacesOrSvi) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachBgpWithPrefixPeeringForSviOrSubinterface

type ConnectivityTemplatePrimitiveAttributesAttachBgpWithPrefixPeeringForSviOrSubinterface struct {
	Label                 string
	Bfd                   bool
	Holdtime              *uint16
	Ipv4Safi              bool
	Ipv6Safi              bool
	Keepalive             *uint16
	LocalAsn              *uint32
	Password              *string
	PrefixNeighborIpv4    *net.IPNet
	PrefixNeighborIpv6    *net.IPNet
	SessionAddressingIpv4 bool
	SessionAddressingIpv6 bool
	Ttl                   uint8
}

func (*ConnectivityTemplatePrimitiveAttributesAttachBgpWithPrefixPeeringForSviOrSubinterface) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachBgpWithPrefixPeeringForSviOrSubinterface) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachCustomStaticRoute

type ConnectivityTemplatePrimitiveAttributesAttachCustomStaticRoute struct {
	Label        string
	Network      *net.IPNet
	NextHop      net.IP
	SecurityZone *ObjectId
}

func (*ConnectivityTemplatePrimitiveAttributesAttachCustomStaticRoute) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachCustomStaticRoute) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachExistingRoutingPolicy

type ConnectivityTemplatePrimitiveAttributesAttachExistingRoutingPolicy struct {
	Label      string
	RpToAttach *ObjectId
}

func (*ConnectivityTemplatePrimitiveAttributesAttachExistingRoutingPolicy) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachExistingRoutingPolicy) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachIpEndpointWithBgpNsxt

type ConnectivityTemplatePrimitiveAttributesAttachIpEndpointWithBgpNsxt struct {
	Label              string
	Asn                *uint32
	Bfd                bool
	Holdtime           *uint16
	Ipv4Addr           net.IP
	Ipv6Addr           net.IP
	Ipv4Safi           bool
	Ipv6Safi           bool
	Keepalive          *uint16
	LocalAsn           *uint32
	NeighborAsnDynamic bool
	Password           *string
	Ttl                uint8
}

func (*ConnectivityTemplatePrimitiveAttributesAttachIpEndpointWithBgpNsxt) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachIpEndpointWithBgpNsxt) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachLogicalLink struct {
	Label              string
	SecurityZone       *ObjectId
	Tagged             bool
	Vlan               *Vlan
	IPv4AddressingType CtPrimitiveIPv4AddressingType
	IPv6AddressingType CtPrimitiveIPv6AddressingType
	L3Mtu              *uint16
}

func (*ConnectivityTemplatePrimitiveAttributesAttachLogicalLink) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachLogicalLink) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachMultipleVlan

type ConnectivityTemplatePrimitiveAttributesAttachMultipleVlan struct {
	Label            string
	UntaggedVnNodeId *ObjectId
	TaggedVnNodeIds  []ObjectId
}

func (*ConnectivityTemplatePrimitiveAttributesAttachMultipleVlan) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachMultipleVlan) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachRoutingZoneConstraint

type ConnectivityTemplatePrimitiveAttributesAttachRoutingZoneConstraint struct {
	Label                 string
	RoutingZoneConstraint *ObjectId
}

func (*ConnectivityTemplatePrimitiveAttributesAttachRoutingZoneConstraint) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachRoutingZoneConstraint) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachSingleVlan

type ConnectivityTemplatePrimitiveAttributesAttachSingleVlan struct {
	Label    string
	Tagged   bool
	VnNodeId *ObjectId
}

func (*ConnectivityTemplatePrimitiveAttributesAttachSingleVlan) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachSingleVlan) PolicyTypeName

type ConnectivityTemplatePrimitiveAttributesAttachStaticRoute

type ConnectivityTemplatePrimitiveAttributesAttachStaticRoute struct {
	Label           string
	ShareIpEndpoint bool
	Network         *net.IPNet
}

func (*ConnectivityTemplatePrimitiveAttributesAttachStaticRoute) Description

func (*ConnectivityTemplatePrimitiveAttributesAttachStaticRoute) PolicyTypeName

type ConnectivityTemplatePrimitiveUserData

type ConnectivityTemplatePrimitiveUserData struct {
	IsSausage bool                   `json:"isSausage"`
	Positions map[ObjectId][]float64 `json:"positions"`
}

type ConnectivityTemplateState

type ConnectivityTemplateState struct {
	Id                ObjectId
	Status            CtPrimitiveStatus
	AppPointsCount    int
	MissingAttributes map[string]string
}

type ContainerStatus

type ContainerStatus struct {
	Status     string `json:"status"`
	Name       string `json:"name"`
	TaskId     string `json:"task_id"`
	LastUpdate string `json:"last_update"`
	Host       string `json:"host"`
	Error      string `json:"error"`
	ServiceId  string `json:"service_id"`
}

type CountersAlert

type CountersAlert struct {

	// Types that are assignable to Id:
	//	*CountersAlert_NodeRole
	//	*CountersAlert_PortRole
	//	*CountersAlert_Port
	//	*CountersAlert_Node
	//	*CountersAlert_Pod
	Id              isCountersAlert_Id `protobuf_oneof:"id"`
	MeasurementName *string            `protobuf:"bytes,6,req,name=measurement_name,json=measurementName" json:"measurement_name,omitempty"`
	IntervalSeconds *uint32            `protobuf:"varint,7,req,name=interval_seconds,json=intervalSeconds" json:"interval_seconds,omitempty"`
	AggregationType *AggregationType   `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CountersAlert) Descriptor deprecated

func (*CountersAlert) Descriptor() ([]byte, []int)

Deprecated: Use CountersAlert.ProtoReflect.Descriptor instead.

func (*CountersAlert) GetAggregationType

func (x *CountersAlert) GetAggregationType() AggregationType

func (*CountersAlert) GetId

func (m *CountersAlert) GetId() isCountersAlert_Id

func (*CountersAlert) GetIntervalSeconds

func (x *CountersAlert) GetIntervalSeconds() uint32

func (*CountersAlert) GetMeasurementName

func (x *CountersAlert) GetMeasurementName() string

func (*CountersAlert) GetNode

func (x *CountersAlert) GetNode() string

func (*CountersAlert) GetNodeRole

func (x *CountersAlert) GetNodeRole() Feature

func (*CountersAlert) GetPod

func (x *CountersAlert) GetPod() bool

func (*CountersAlert) GetPort

func (x *CountersAlert) GetPort() string

func (*CountersAlert) GetPortRole

func (x *CountersAlert) GetPortRole() Feature

func (*CountersAlert) ProtoMessage

func (*CountersAlert) ProtoMessage()

func (*CountersAlert) ProtoReflect

func (x *CountersAlert) ProtoReflect() protoreflect.Message

func (*CountersAlert) Reset

func (x *CountersAlert) Reset()

func (*CountersAlert) String

func (x *CountersAlert) String() string

type CountersAlert_Node

type CountersAlert_Node struct {
	Node string `protobuf:"bytes,4,opt,name=node,oneof"`
}

type CountersAlert_NodeRole

type CountersAlert_NodeRole struct {
	NodeRole Feature `protobuf:"varint,1,opt,name=node_role,json=nodeRole,enum=aos.streaming.Feature,oneof"`
}

type CountersAlert_Pod

type CountersAlert_Pod struct {
	Pod bool `protobuf:"varint,5,opt,name=pod,oneof"`
}

type CountersAlert_Port

type CountersAlert_Port struct {
	Port string `protobuf:"bytes,3,opt,name=port,oneof"`
}

type CountersAlert_PortRole

type CountersAlert_PortRole struct {
	PortRole Feature `protobuf:"varint,2,opt,name=port_role,json=portRole,enum=aos.streaming.Feature,oneof"`
}

type CreateBlueprintFromTemplateRequest

type CreateBlueprintFromTemplateRequest struct {
	RefDesign                 RefDesign
	Label                     string
	TemplateId                ObjectId
	FabricSettings            *FabricSettings
	SkipCablingReadinessCheck bool
}

type CreateL3CollapsedTemplateRequest

type CreateL3CollapsedTemplateRequest struct {
	DisplayName          string                 `json:"display_name"`
	MeshLinkCount        int                    `json:"mesh_link_count"`
	MeshLinkSpeed        LogicalDevicePortSpeed `json:"mesh_link_speed"`
	RackTypeIds          []ObjectId             `json:"rack_types"`
	RackTypeCounts       []RackTypeCount        `json:"rack_type_counts"`
	DhcpServiceIntent    DhcpServiceIntent      `json:"dhcp_service_intent"`
	AntiAffinityPolicy   *AntiAffinityPolicy    `json:"anti_affinity_policy,omitempty"`
	VirtualNetworkPolicy VirtualNetworkPolicy   `json:"virtual_network_policy"`
}

type CreateLinkRequest

type CreateLinkRequest struct {
	Tags           []string
	SystemEndpoint SwitchLinkEndpoint
	SwitchEndpoint SwitchLinkEndpoint
	GroupLabel     string
	LagMode        RackLinkLagMode
}

type CreateLinksWithNewSystemRequest

type CreateLinksWithNewSystemRequest struct {
	Links  []CreateLinkRequest
	System CreateLinksWithNewSystemRequestSystem
}

type CreateLinksWithNewSystemRequestSystem

type CreateLinksWithNewSystemRequestSystem struct {
	Hostname         string
	Label            string
	LogicalDeviceId  ObjectId
	LogicalDevice    *LogicalDevice
	PortChannelIdMin int
	PortChannelIdMax int
	Tags             []string
	Type             SystemType
}

type CreatePodBasedTemplateRequest

type CreatePodBasedTemplateRequest struct {
	DisplayName            string
	Superspine             *TemplateElementSuperspineRequest
	PodInfos               map[ObjectId]TemplatePodBasedInfo
	AntiAffinityPolicy     *AntiAffinityPolicy
	FabricAddressingPolicy *TemplateFabricAddressingPolicy410Only // Apstra 4.1.0 only
}

type CreateRackBasedTemplateRequest

type CreateRackBasedTemplateRequest struct {
	DisplayName            string
	Spine                  *TemplateElementSpineRequest
	RackInfos              map[ObjectId]TemplateRackBasedRackInfo
	DhcpServiceIntent      *DhcpServiceIntent
	AntiAffinityPolicy     *AntiAffinityPolicy
	AsnAllocationPolicy    *AsnAllocationPolicy
	FabricAddressingPolicy *TemplateFabricAddressingPolicy410Only // Apstra 4.1.0 only
	VirtualNetworkPolicy   *VirtualNetworkPolicy
}

type CtPrimitiveBgpPeerTo

type CtPrimitiveBgpPeerTo int

func (*CtPrimitiveBgpPeerTo) FromString

func (o *CtPrimitiveBgpPeerTo) FromString(in string) error

func (CtPrimitiveBgpPeerTo) String

func (o CtPrimitiveBgpPeerTo) String() string

type CtPrimitiveIPv4AddressingType

type CtPrimitiveIPv4AddressingType int

func (*CtPrimitiveIPv4AddressingType) FromString

func (o *CtPrimitiveIPv4AddressingType) FromString(in string) error

func (CtPrimitiveIPv4AddressingType) String

type CtPrimitiveIPv4ProtocolSessionAddressing

type CtPrimitiveIPv4ProtocolSessionAddressing int

func (*CtPrimitiveIPv4ProtocolSessionAddressing) FromString

func (CtPrimitiveIPv4ProtocolSessionAddressing) String

type CtPrimitiveIPv6AddressingType

type CtPrimitiveIPv6AddressingType int

func (*CtPrimitiveIPv6AddressingType) FromString

func (o *CtPrimitiveIPv6AddressingType) FromString(in string) error

func (CtPrimitiveIPv6AddressingType) String

type CtPrimitiveIPv6ProtocolSessionAddressing

type CtPrimitiveIPv6ProtocolSessionAddressing int

func (*CtPrimitiveIPv6ProtocolSessionAddressing) FromString

func (CtPrimitiveIPv6ProtocolSessionAddressing) String

type CtPrimitivePolicyTypeName

type CtPrimitivePolicyTypeName int

func (*CtPrimitivePolicyTypeName) FromString

func (o *CtPrimitivePolicyTypeName) FromString(in string) error

func (CtPrimitivePolicyTypeName) String

func (o CtPrimitivePolicyTypeName) String() string

type CtPrimitiveStatus

type CtPrimitiveStatus int

func (*CtPrimitiveStatus) FromString

func (o *CtPrimitiveStatus) FromString(in string) error

func (CtPrimitiveStatus) String

func (o CtPrimitiveStatus) String() string

type DcRoutingExportPolicy

type DcRoutingExportPolicy struct {
	StaticRoutes         bool `json:"static_routes"`
	Loopbacks            bool `json:"loopbacks"`
	SpineSuperspineLinks bool `json:"spine_superspine_links"`
	L3EdgeServerLinks    bool `json:"l3edge_server_links"`
	SpineLeafLinks       bool `json:"spine_leaf_links"`
	L2EdgeSubnets        bool `json:"l2edge_subnets"`
}

type DcRoutingPolicy

type DcRoutingPolicy struct {
	Id   ObjectId
	Data *DcRoutingPolicyData
}

type DcRoutingPolicyData

type DcRoutingPolicyData struct {
	Label                  string                      `json:"label"`
	Description            string                      `json:"description"`
	PolicyType             DcRoutingPolicyType         `json:"policy_type"`
	ImportPolicy           DcRoutingPolicyImportPolicy `json:"import_policy"`
	ExportPolicy           DcRoutingExportPolicy       `json:"export_policy"`
	ExpectDefaultIpv4Route bool                        `json:"expect_default_ipv4_route"`
	ExpectDefaultIpv6Route bool                        `json:"expect_default_ipv6_route"`
	AggregatePrefixes      []net.IPNet                 `json:"aggregate_prefixes"`
	ExtraImportRoutes      []PrefixFilter              `json:"extra_import_routes"`
	ExtraExportRoutes      []PrefixFilter              `json:"extra_export_routes"`
}

type DcRoutingPolicyImportPolicy

type DcRoutingPolicyImportPolicy int

func AllDcRoutingPolicyImportPolicies

func AllDcRoutingPolicyImportPolicies() []DcRoutingPolicyImportPolicy

AllDcRoutingPolicyImportPolicies returns the []DcRoutingPolicyImportPolicy representing each possible DcRoutingPolicyImportPolicy

func (*DcRoutingPolicyImportPolicy) FromString

func (o *DcRoutingPolicyImportPolicy) FromString(in string) error

func (DcRoutingPolicyImportPolicy) Int

func (DcRoutingPolicyImportPolicy) String

type DcRoutingPolicyType

type DcRoutingPolicyType int

func (*DcRoutingPolicyType) FromString

func (o *DcRoutingPolicyType) FromString(in string) error

func (DcRoutingPolicyType) Int

func (o DcRoutingPolicyType) Int() int

func (DcRoutingPolicyType) String

func (o DcRoutingPolicyType) String() string

type DeployMode

type DeployMode oenum.Member[string]

func (*DeployMode) FromString

func (o *DeployMode) FromString(s string) error

func (DeployMode) String

func (o DeployMode) String() string

type DeployStatus

type DeployStatus int

func (DeployStatus) Int

func (o DeployStatus) Int() int

func (DeployStatus) String

func (o DeployStatus) String() string

type DeploymentAlert

type DeploymentAlert struct {
	ExpectedDeploymentStatus *DeploymentStatus `` /* 165-byte string literal not displayed */
	ActualDeploymentStatus   *DeploymentStatus `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DeploymentAlert) Descriptor deprecated

func (*DeploymentAlert) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentAlert.ProtoReflect.Descriptor instead.

func (*DeploymentAlert) GetActualDeploymentStatus

func (x *DeploymentAlert) GetActualDeploymentStatus() DeploymentStatus

func (*DeploymentAlert) GetExpectedDeploymentStatus

func (x *DeploymentAlert) GetExpectedDeploymentStatus() DeploymentStatus

func (*DeploymentAlert) ProtoMessage

func (*DeploymentAlert) ProtoMessage()

func (*DeploymentAlert) ProtoReflect

func (x *DeploymentAlert) ProtoReflect() protoreflect.Message

func (*DeploymentAlert) Reset

func (x *DeploymentAlert) Reset()

func (*DeploymentAlert) String

func (x *DeploymentAlert) String() string

type DeploymentStatus

type DeploymentStatus int32
const (
	DeploymentStatus_DEPLOYMENT_STATUS_INPROGRESS DeploymentStatus = 0
	DeploymentStatus_DEPLOYMENT_STATUS_SUCCEEDED  DeploymentStatus = 1
	DeploymentStatus_DEPLOYMENT_STATUS_FAILED     DeploymentStatus = 2
)

func (DeploymentStatus) Descriptor

func (DeploymentStatus) Enum

func (DeploymentStatus) EnumDescriptor deprecated

func (DeploymentStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeploymentStatus.Descriptor instead.

func (DeploymentStatus) Number

func (DeploymentStatus) String

func (x DeploymentStatus) String() string

func (DeploymentStatus) Type

func (*DeploymentStatus) UnmarshalJSON deprecated

func (x *DeploymentStatus) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type DesignTag

type DesignTag struct {
	Id             ObjectId
	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *DesignTagData
}

type DesignTagData

type DesignTagData struct {
	Label       string `json:"label"`
	Description string `json:"description"`
}

type DesignTagRequest

type DesignTagRequest DesignTagData

type DeviceFacts

type DeviceFacts struct {
	DeviceOsFamily  string `json:"device_os_family"`
	Hostname        string `json:"hostname"`
	DeviceState     string `json:"device_state"`
	DeviceOsVersion string `json:"device_os_version"`
}

type DeviceProfile

type DeviceProfile struct {
	Id             ObjectId
	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *DeviceProfileData
}

type DeviceProfileChassisInfo

type DeviceProfileChassisInfo struct {
	ChassisProfileId     string               `json:"chassis_profile_id"`
	HardwareCapabilities HardwareCapabilities `json:"hardware_capabilities"`
	SoftwareCapabilities SoftwareCapabilities `json:"software_capabilities"`
	Selector             DeviceSelector       `json:"selector"`
}

type DeviceProfileData

type DeviceProfileData struct {
	Label                string
	DeviceProfileType    string
	ChassisProfileId     string
	ChassisCount         int
	SlotCount            int
	HardwareCapabilities HardwareCapabilities
	SoftwareCapabilities SoftwareCapabilities
	Ports                []PortInfo
	Selector             DeviceSelector
	ChassisInfo          DeviceProfileChassisInfo
	LinecardsInfo        []DeviceProfileLinecardInfo
	SlotConfiguration    []DeviceProfileSlotConfiguration
}

func (*DeviceProfileData) PortById

func (o *DeviceProfileData) PortById(desired int) (*PortInfo, error)

func (*DeviceProfileData) PortByInterfaceName

func (o *DeviceProfileData) PortByInterfaceName(desired string) (*PortInfo, error)

PortByInterfaceName returns *PortInfo describing the port which has an interface/transform that uses the desired name. If zero ports or multiple ports use the desired name, an error is returned.

func (*DeviceProfileData) PortsByInterfaceName

func (o *DeviceProfileData) PortsByInterfaceName(desired string) []PortInfo

PortsByInterfaceName returns []PortInfo containing all ports/transformations/interfaces which match the desired name string

type DeviceProfileLinecardInfo

type DeviceProfileLinecardInfo struct {
	HardwareCapabilities HardwareCapabilities `json:"hardware_capabilities"`
	LinecardProfileId    string               `json:"linecard_profile_id"`
	Selector             DeviceSelector       `json:"selector"`
}

type DeviceProfileSlotConfiguration

type DeviceProfileSlotConfiguration struct {
	LinecardProfileId string `json:"linecard_profile_id"`
	SlotId            int    `json:"slot_id"`
}

type DeviceProfileType

type DeviceProfileType oenum.Member[string]

func (*DeviceProfileType) FromString

func (o *DeviceProfileType) FromString(s string) error

func (DeviceProfileType) String

func (o DeviceProfileType) String() string

type DeviceSelector

type DeviceSelector struct {
	OsVersion    string `json:"os_version"`
	Model        string `json:"model"`
	Os           string `json:"os"`
	Manufacturer string `json:"manufacturer"`
}

type DeviceState

type DeviceState int32
const (
	DeviceState_DEVICE_STATE_IS_ACTIVE       DeviceState = 1
	DeviceState_DEVICE_STATE_IS_READY        DeviceState = 2
	DeviceState_DEVICE_STATE_IS_NOCOMMS      DeviceState = 3
	DeviceState_DEVICE_STATE_IS_MAINT        DeviceState = 4
	DeviceState_DEVICE_STATE_IS_REBOOTING    DeviceState = 5
	DeviceState_DEVICE_STATE_OOS_STOCKED     DeviceState = 6
	DeviceState_DEVICE_STATE_OOS_QUARANTINED DeviceState = 7
	DeviceState_DEVICE_STATE_OOS_READY       DeviceState = 8
	DeviceState_DEVICE_STATE_OOS_NOCOMMS     DeviceState = 9
	DeviceState_DEVICE_STATE_OOS_DECOMM      DeviceState = 10
	DeviceState_DEVICE_STATE_OOS_MAINT       DeviceState = 11
	DeviceState_DEVICE_STATE_OOS_REBOOTING   DeviceState = 12
	DeviceState_DEVICE_STATE_ERROR           DeviceState = 13
)

func (DeviceState) Descriptor

func (DeviceState) Enum

func (x DeviceState) Enum() *DeviceState

func (DeviceState) EnumDescriptor deprecated

func (DeviceState) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeviceState.Descriptor instead.

func (DeviceState) Number

func (x DeviceState) Number() protoreflect.EnumNumber

func (DeviceState) String

func (x DeviceState) String() string

func (DeviceState) Type

func (*DeviceState) UnmarshalJSON deprecated

func (x *DeviceState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type DeviceStateEvent

type DeviceStateEvent struct {
	State *DeviceState `protobuf:"varint,1,req,name=state,enum=aos.streaming.DeviceState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceStateEvent) Descriptor deprecated

func (*DeviceStateEvent) Descriptor() ([]byte, []int)

Deprecated: Use DeviceStateEvent.ProtoReflect.Descriptor instead.

func (*DeviceStateEvent) GetState

func (x *DeviceStateEvent) GetState() DeviceState

func (*DeviceStateEvent) ProtoMessage

func (*DeviceStateEvent) ProtoMessage()

func (*DeviceStateEvent) ProtoReflect

func (x *DeviceStateEvent) ProtoReflect() protoreflect.Message

func (*DeviceStateEvent) Reset

func (x *DeviceStateEvent) Reset()

func (*DeviceStateEvent) String

func (x *DeviceStateEvent) String() string

type DhcpServiceEnabled

type DhcpServiceEnabled bool

type DhcpServiceIntent

type DhcpServiceIntent struct {
	Active bool `json:"active"`
}

type Endpoint

type Endpoint struct {
	InterfaceId ObjectId `json:"interface_id"`
	TagType     string   `json:"tag_type"`
	Label       string   `json:"label"`
}

type ErrCtAssignedToLinkDetail

type ErrCtAssignedToLinkDetail struct {
	LinkIds []ObjectId
}

type EsiLagInfo

type EsiLagInfo struct {
	AccessAccessLinkCount int
	AccessAccessLinkSpeed LogicalDevicePortSpeed
}

type Event

type Event struct {
	Id *string `protobuf:"bytes,1,req,name=id" json:"id,omitempty"` // uuid
	// Types that are assignable to Data:
	//	*Event_DeviceState
	//	*Event_Streaming
	//	*Event_CablePeer
	//	*Event_BgpNeighbor
	//	*Event_LinkStatus
	//	*Event_Traffic
	//	*Event_MacState
	//	*Event_ArpState
	//	*Event_LagState
	//	*Event_MlagState
	//	*Event_ExtensibleEvent
	//	*Event_RouteState
	Data isEvent_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetArpState

func (x *Event) GetArpState() *ArpEvent

func (*Event) GetBgpNeighbor

func (x *Event) GetBgpNeighbor() *BGPNeighborEvent

func (*Event) GetCablePeer

func (x *Event) GetCablePeer() *CablePeerEvent

func (*Event) GetData

func (m *Event) GetData() isEvent_Data

func (*Event) GetDeviceState

func (x *Event) GetDeviceState() *DeviceStateEvent

func (*Event) GetExtensibleEvent

func (x *Event) GetExtensibleEvent() *ExtensibleServiceEvent

func (*Event) GetId

func (x *Event) GetId() string

func (*Event) GetLagState

func (x *Event) GetLagState() *LagEvent

func (*Event) GetLinkStatus

func (x *Event) GetLinkStatus() *LinkStatusEvent

func (*Event) GetMacState

func (x *Event) GetMacState() *MacEvent

func (*Event) GetMlagState

func (x *Event) GetMlagState() *MlagEvent

func (*Event) GetRouteState

func (x *Event) GetRouteState() *RouteEvent

func (*Event) GetStreaming

func (x *Event) GetStreaming() *StreamingEvent

func (*Event) GetTraffic

func (x *Event) GetTraffic() *TrafficEvent

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Event_ArpState

type Event_ArpState struct {
	ArpState *ArpEvent `protobuf:"bytes,9,opt,name=arp_state,json=arpState,oneof"`
}

type Event_BgpNeighbor

type Event_BgpNeighbor struct {
	BgpNeighbor *BGPNeighborEvent `protobuf:"bytes,5,opt,name=bgp_neighbor,json=bgpNeighbor,oneof"`
}

type Event_CablePeer

type Event_CablePeer struct {
	CablePeer *CablePeerEvent `protobuf:"bytes,4,opt,name=cable_peer,json=cablePeer,oneof"`
}

type Event_DeviceState

type Event_DeviceState struct {
	DeviceState *DeviceStateEvent `protobuf:"bytes,2,opt,name=device_state,json=deviceState,oneof"`
}

type Event_ExtensibleEvent

type Event_ExtensibleEvent struct {
	ExtensibleEvent *ExtensibleServiceEvent `protobuf:"bytes,12,opt,name=extensible_event,json=extensibleEvent,oneof"`
}

type Event_LagState

type Event_LagState struct {
	LagState *LagEvent `protobuf:"bytes,10,opt,name=lag_state,json=lagState,oneof"`
}

type Event_LinkStatus

type Event_LinkStatus struct {
	LinkStatus *LinkStatusEvent `protobuf:"bytes,6,opt,name=link_status,json=linkStatus,oneof"`
}

type Event_MacState

type Event_MacState struct {
	MacState *MacEvent `protobuf:"bytes,8,opt,name=mac_state,json=macState,oneof"`
}

type Event_MlagState

type Event_MlagState struct {
	MlagState *MlagEvent `protobuf:"bytes,11,opt,name=mlag_state,json=mlagState,oneof"`
}

type Event_RouteState

type Event_RouteState struct {
	RouteState *RouteEvent `protobuf:"bytes,13,opt,name=route_state,json=routeState,oneof"`
}

type Event_Streaming

type Event_Streaming struct {
	Streaming *StreamingEvent `protobuf:"bytes,3,opt,name=streaming,oneof"`
}

type Event_Traffic

type Event_Traffic struct {
	Traffic *TrafficEvent `protobuf:"bytes,7,opt,name=traffic,oneof"`
}

type EvpnType3RouteEvent

type EvpnType3RouteEvent struct {
	State    *RouteState `protobuf:"varint,1,req,name=state,enum=aos.streaming.RouteState" json:"state,omitempty"`
	SystemId *string     `protobuf:"bytes,2,req,name=system_id,json=systemId" json:"system_id,omitempty"`
	Vni      *uint32     `protobuf:"varint,3,req,name=vni" json:"vni,omitempty"`
	NextHop  *string     `protobuf:"bytes,4,req,name=next_hop,json=nextHop" json:"next_hop,omitempty"`
	Rd       *string     `protobuf:"bytes,5,req,name=rd" json:"rd,omitempty"`
	Rt       *string     `protobuf:"bytes,6,req,name=rt" json:"rt,omitempty"`
	// contains filtered or unexported fields
}

func (*EvpnType3RouteEvent) Descriptor deprecated

func (*EvpnType3RouteEvent) Descriptor() ([]byte, []int)

Deprecated: Use EvpnType3RouteEvent.ProtoReflect.Descriptor instead.

func (*EvpnType3RouteEvent) GetNextHop

func (x *EvpnType3RouteEvent) GetNextHop() string

func (*EvpnType3RouteEvent) GetRd

func (x *EvpnType3RouteEvent) GetRd() string

func (*EvpnType3RouteEvent) GetRt

func (x *EvpnType3RouteEvent) GetRt() string

func (*EvpnType3RouteEvent) GetState

func (x *EvpnType3RouteEvent) GetState() RouteState

func (*EvpnType3RouteEvent) GetSystemId

func (x *EvpnType3RouteEvent) GetSystemId() string

func (*EvpnType3RouteEvent) GetVni

func (x *EvpnType3RouteEvent) GetVni() uint32

func (*EvpnType3RouteEvent) ProtoMessage

func (*EvpnType3RouteEvent) ProtoMessage()

func (*EvpnType3RouteEvent) ProtoReflect

func (x *EvpnType3RouteEvent) ProtoReflect() protoreflect.Message

func (*EvpnType3RouteEvent) Reset

func (x *EvpnType3RouteEvent) Reset()

func (*EvpnType3RouteEvent) String

func (x *EvpnType3RouteEvent) String() string

type EvpnType5RouteEvent

type EvpnType5RouteEvent struct {
	State    *RouteState `protobuf:"varint,1,req,name=state,enum=aos.streaming.RouteState" json:"state,omitempty"`
	SystemId *string     `protobuf:"bytes,2,req,name=system_id,json=systemId" json:"system_id,omitempty"`
	Af       *string     `protobuf:"bytes,3,req,name=af" json:"af,omitempty"`
	Subnet   *string     `protobuf:"bytes,4,req,name=subnet" json:"subnet,omitempty"`
	NextHop  *string     `protobuf:"bytes,5,req,name=next_hop,json=nextHop" json:"next_hop,omitempty"`
	Rd       *string     `protobuf:"bytes,6,req,name=rd" json:"rd,omitempty"`
	Rt       *string     `protobuf:"bytes,7,req,name=rt" json:"rt,omitempty"`
	// contains filtered or unexported fields
}

func (*EvpnType5RouteEvent) Descriptor deprecated

func (*EvpnType5RouteEvent) Descriptor() ([]byte, []int)

Deprecated: Use EvpnType5RouteEvent.ProtoReflect.Descriptor instead.

func (*EvpnType5RouteEvent) GetAf

func (x *EvpnType5RouteEvent) GetAf() string

func (*EvpnType5RouteEvent) GetNextHop

func (x *EvpnType5RouteEvent) GetNextHop() string

func (*EvpnType5RouteEvent) GetRd

func (x *EvpnType5RouteEvent) GetRd() string

func (*EvpnType5RouteEvent) GetRt

func (x *EvpnType5RouteEvent) GetRt() string

func (*EvpnType5RouteEvent) GetState

func (x *EvpnType5RouteEvent) GetState() RouteState

func (*EvpnType5RouteEvent) GetSubnet

func (x *EvpnType5RouteEvent) GetSubnet() string

func (*EvpnType5RouteEvent) GetSystemId

func (x *EvpnType5RouteEvent) GetSystemId() string

func (*EvpnType5RouteEvent) ProtoMessage

func (*EvpnType5RouteEvent) ProtoMessage()

func (*EvpnType5RouteEvent) ProtoReflect

func (x *EvpnType5RouteEvent) ProtoReflect() protoreflect.Message

func (*EvpnType5RouteEvent) Reset

func (x *EvpnType5RouteEvent) Reset()

func (*EvpnType5RouteEvent) String

func (x *EvpnType5RouteEvent) String() string

type ExtensibleAlert

type ExtensibleAlert struct {
	Key      *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
	Expected *string `protobuf:"bytes,2,req,name=expected" json:"expected,omitempty"`
	Actual   *string `protobuf:"bytes,3,req,name=actual" json:"actual,omitempty"`
	// contains filtered or unexported fields
}

func (*ExtensibleAlert) Descriptor deprecated

func (*ExtensibleAlert) Descriptor() ([]byte, []int)

Deprecated: Use ExtensibleAlert.ProtoReflect.Descriptor instead.

func (*ExtensibleAlert) GetActual

func (x *ExtensibleAlert) GetActual() string

func (*ExtensibleAlert) GetExpected

func (x *ExtensibleAlert) GetExpected() string

func (*ExtensibleAlert) GetKey

func (x *ExtensibleAlert) GetKey() string

func (*ExtensibleAlert) ProtoMessage

func (*ExtensibleAlert) ProtoMessage()

func (*ExtensibleAlert) ProtoReflect

func (x *ExtensibleAlert) ProtoReflect() protoreflect.Message

func (*ExtensibleAlert) Reset

func (x *ExtensibleAlert) Reset()

func (*ExtensibleAlert) String

func (x *ExtensibleAlert) String() string

type ExtensibleServiceEvent

type ExtensibleServiceEvent struct {
	Key   *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
	Value *string `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExtensibleServiceEvent) Descriptor deprecated

func (*ExtensibleServiceEvent) Descriptor() ([]byte, []int)

Deprecated: Use ExtensibleServiceEvent.ProtoReflect.Descriptor instead.

func (*ExtensibleServiceEvent) GetKey

func (x *ExtensibleServiceEvent) GetKey() string

func (*ExtensibleServiceEvent) GetValue

func (x *ExtensibleServiceEvent) GetValue() string

func (*ExtensibleServiceEvent) ProtoMessage

func (*ExtensibleServiceEvent) ProtoMessage()

func (*ExtensibleServiceEvent) ProtoReflect

func (x *ExtensibleServiceEvent) ProtoReflect() protoreflect.Message

func (*ExtensibleServiceEvent) Reset

func (x *ExtensibleServiceEvent) Reset()

func (*ExtensibleServiceEvent) String

func (x *ExtensibleServiceEvent) String() string

type FabricConnectivityDesign

type FabricConnectivityDesign int

func (*FabricConnectivityDesign) FromString

func (o *FabricConnectivityDesign) FromString(in string) error

func (FabricConnectivityDesign) Int

func (o FabricConnectivityDesign) Int() int

func (FabricConnectivityDesign) String

func (o FabricConnectivityDesign) String() string

type FabricSettings

type FabricSettings struct {
	AntiAffinityPolicy                    *AntiAffinityPolicy     // /anti-affinity-policy			/anti-affinity-policy			/anti-affinity-policy			/anti-affinity-policy
	DefaultSviL3Mtu                       *uint16                 // virtual_network_policy node	not supported					not supported					not supported.
	EsiMacMsb                             *uint8                  // /fabric-addressing-policy		/fabric-addressing-policy		/fabric-addressing-policy		/fabric-addressing-policy
	EvpnGenerateType5HostRoutes           *FeatureSwitchEnum      // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	ExternalRouterMtu                     *uint16                 // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	FabricL3Mtu                           *uint16                 // /fabric-addressing-policy		not supported					not supported					not supported
	Ipv6Enabled                           *bool                   // /fabric-addressing-policy		/fabric-addressing-policy		/fabric-addressing-policy		/fabric-addressing-policy
	JunosEvpnDuplicateMacRecoveryTime     *uint16                 // virtual_network_policy node	not supported					not supported					not supported
	JunosEvpnMaxNexthopAndInterfaceNumber *FeatureSwitchEnum      // virtual_network_policy node	not supported					not supported					not supported
	JunosEvpnRoutingInstanceVlanAware     *FeatureSwitchEnum      // virtual_network_policy node	not supported					not supported					not supported
	JunosExOverlayEcmp                    *FeatureSwitchEnum      // virtual_network_policy node	not supported					not supported					not supported
	JunosGracefulRestart                  *FeatureSwitchEnum      // virtual_network_policy node	not supported					not supported					not supported
	MaxEvpnRoutes                         *uint32                 // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	MaxExternalRoutes                     *uint32                 // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	MaxFabricRoutes                       *uint32                 // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	MaxMlagRoutes                         *uint32                 // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	OptimiseSzFootprint                   *FeatureSwitchEnum      // security_zone_policy node		not supported					not supported					not supported
	OverlayControlProtocol                *OverlayControlProtocol // virtual_network_policy node	virtual_network_policy node		virtual_network_policy node		virtual_network_policy node
	SpineLeafLinks                        *AddressingScheme       // blueprint creation only		blueprint creation only			blueprint creation only			blueprint creation only
	SpineSuperspineLinks                  *AddressingScheme       // blueprint creation only		blueprint creation only			blueprint creation only			blueprint creation only
}

type Feature

type Feature int32
const (
	Feature_FEATURE_UNKNOWN             Feature = 0
	Feature_FEATURE_LO0                 Feature = 1
	Feature_FEATURE_FABRIC              Feature = 2
	Feature_FEATURE_LEAF_SERVER         Feature = 3
	Feature_FEATURE_L3EDGE              Feature = 4
	Feature_FEATURE_L2EDGE              Feature = 5
	Feature_FEATURE_SPINE_LEAF          Feature = 6
	Feature_FEATURE_FABRIC_SPINE        Feature = 7
	Feature_FEATURE_EXTERNAL_ROUTER     Feature = 8
	Feature_FEATURE_TO_EXTERNAL_ROUTER  Feature = 9
	Feature_FEATURE_LEAF_L3_SERVER      Feature = 10
	Feature_FEATURE_LEAF_L2_SERVER      Feature = 11
	Feature_FEATURE_LEAF                Feature = 12
	Feature_FEATURE_SPINE               Feature = 13
	Feature_FEATURE_L3_SERVER           Feature = 14
	Feature_FEATURE_L2_SERVER           Feature = 15
	Feature_FEATURE_SERVER              Feature = 16
	Feature_FEATURE_PEER                Feature = 17
	Feature_FEATURE_LEAF_PEER_LINK      Feature = 18
	Feature_FEATURE_LEAF_PAIR           Feature = 19
	Feature_FEATURE_LEAF_PAIR_L2_SERVER Feature = 20
	Feature_FEATURE_UNUSED              Feature = 21
)

func (Feature) Descriptor

func (Feature) Descriptor() protoreflect.EnumDescriptor

func (Feature) Enum

func (x Feature) Enum() *Feature

func (Feature) EnumDescriptor deprecated

func (Feature) EnumDescriptor() ([]byte, []int)

Deprecated: Use Feature.Descriptor instead.

func (Feature) Number

func (x Feature) Number() protoreflect.EnumNumber

func (Feature) String

func (x Feature) String() string

func (Feature) Type

func (Feature) Type() protoreflect.EnumType

func (*Feature) UnmarshalJSON deprecated

func (x *Feature) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type FeatureSwitch

type FeatureSwitch int

func (FeatureSwitch) Int

func (o FeatureSwitch) Int() int

func (FeatureSwitch) String

func (o FeatureSwitch) String() string

type FeatureSwitchEnum

type FeatureSwitchEnum oenum.Member[string]

func (*FeatureSwitchEnum) FromString

func (o *FeatureSwitchEnum) FromString(s string) error

func (FeatureSwitchEnum) String

func (o FeatureSwitchEnum) String() string

type Field

type Field struct {
	Name *string `protobuf:"bytes,5,req,name=name" json:"name,omitempty"`
	// Types that are assignable to Value:
	//	*Field_Int64Value
	//	*Field_FloatValue
	//	*Field_StringValue
	Value isField_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

func (*Field) Descriptor deprecated

func (*Field) Descriptor() ([]byte, []int)

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetFloatValue

func (x *Field) GetFloatValue() float32

func (*Field) GetInt64Value

func (x *Field) GetInt64Value() int64

func (*Field) GetName

func (x *Field) GetName() string

func (*Field) GetStringValue

func (x *Field) GetStringValue() string

func (*Field) GetValue

func (m *Field) GetValue() isField_Value

func (*Field) ProtoMessage

func (*Field) ProtoMessage()

func (*Field) ProtoReflect

func (x *Field) ProtoReflect() protoreflect.Message

func (*Field) Reset

func (x *Field) Reset()

func (*Field) String

func (x *Field) String() string

type Field_FloatValue

type Field_FloatValue struct {
	FloatValue float32 `protobuf:"fixed32,2,opt,name=float_value,json=floatValue,oneof"`
}

type Field_Int64Value

type Field_Int64Value struct {
	Int64Value int64 `protobuf:"varint,1,opt,name=int64_value,json=int64Value,oneof"`
}

type Field_StringValue

type Field_StringValue struct {
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,oneof"`
}

type FileInfo

type FileInfo struct {
	FileName *string `protobuf:"bytes,1,req,name=file_name,json=fileName" json:"file_name,omitempty"`
	FileSize *uint64 `protobuf:"varint,2,req,name=file_size,json=fileSize" json:"file_size,omitempty"`
	// contains filtered or unexported fields
}

func (*FileInfo) Descriptor deprecated

func (*FileInfo) Descriptor() ([]byte, []int)

Deprecated: Use FileInfo.ProtoReflect.Descriptor instead.

func (*FileInfo) GetFileName

func (x *FileInfo) GetFileName() string

func (*FileInfo) GetFileSize

func (x *FileInfo) GetFileSize() uint64

func (*FileInfo) ProtoMessage

func (*FileInfo) ProtoMessage()

func (*FileInfo) ProtoReflect

func (x *FileInfo) ProtoReflect() protoreflect.Message

func (*FileInfo) Reset

func (x *FileInfo) Reset()

func (*FileInfo) String

func (x *FileInfo) String() string

type GenericPerfmonMessage

type GenericPerfmonMessage struct {
	Tags   []*Tag   `protobuf:"bytes,1,rep,name=tags" json:"tags,omitempty"`
	Fields []*Field `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericPerfmonMessage) Descriptor deprecated

func (*GenericPerfmonMessage) Descriptor() ([]byte, []int)

Deprecated: Use GenericPerfmonMessage.ProtoReflect.Descriptor instead.

func (*GenericPerfmonMessage) GetFields

func (x *GenericPerfmonMessage) GetFields() []*Field

func (*GenericPerfmonMessage) GetTags

func (x *GenericPerfmonMessage) GetTags() []*Tag

func (*GenericPerfmonMessage) ProtoMessage

func (*GenericPerfmonMessage) ProtoMessage()

func (*GenericPerfmonMessage) ProtoReflect

func (x *GenericPerfmonMessage) ProtoReflect() protoreflect.Message

func (*GenericPerfmonMessage) Reset

func (x *GenericPerfmonMessage) Reset()

func (*GenericPerfmonMessage) String

func (x *GenericPerfmonMessage) String() string

type GenericSystemLoopback

type GenericSystemLoopback struct {
	Ipv4Addr       *net.IPNet
	Ipv6Addr       *net.IPNet
	LoopbackNodeId ObjectId
	LoopbackId     uint32
	SecurityZoneId ObjectId
}

type GetTelemetryServiceMappingResult

type GetTelemetryServiceMappingResult struct {
	Configured    []TelemetryServiceMapping `json:"configured"`
	LastRunError  []TelemetryServiceMapping `json:"last_run_error"`
	EnablingError []TelemetryServiceMapping `json:"enabling_error"`
}

type HardwareCapabilities

type HardwareCapabilities struct {
	FormFactor     string `json:"form_factor"`
	Cpu            string `json:"cpu"`
	Ram            int    `json:"ram"`
	Asic           string `json:"asic"`
	MaxL2Mtu       int    `json:"max_l2_mtu"`
	MaxL3Mtu       int    `json:"max_l3_mtu"`
	Userland       int    `json:"userland"`
	VtepLimit      int    `json:"vtep_limit"`
	BfdSupported   bool   `json:"bfd_supported"`
	VxlanSupported bool   `json:"vxlan_supported"`
	VtepFloodLimit int    `json:"vtep_flood_limit"`
	EcmpLimit      int    `json:"ecmp_limit"`
	VrfLimit       int    `json:"vrf_limit"`
	CoppStrict     []struct {
		Version string `json:"version"`
		Value   bool   `json:"value"`
	} `json:"copp_strict"`
	BreakoutCapable []struct {
		Version string `json:"version"`
		Value   bool   `json:"value"`
		Module  int    `json:"module"`
	} `json:"breakout_capable"`
	RoutingInstanceSupported []struct {
		Version string `json:"version"`
		Value   bool   `json:"value"`
	} `json:"routing_instance_supported"`
	AsSeqNumSupported []struct {
		Version string `json:"version"`
		Value   bool   `json:"value"`
	} `json:"as_seq_num_supported"`
}

type HeadroomAlert

type HeadroomAlert struct {
	NodeA           *string       `protobuf:"bytes,1,req,name=node_a,json=nodeA" json:"node_a,omitempty"`
	NodeB           *string       `protobuf:"bytes,2,req,name=node_b,json=nodeB" json:"node_b,omitempty"`
	IntervalSeconds *uint32       `protobuf:"varint,3,req,name=interval_seconds,json=intervalSeconds" json:"interval_seconds,omitempty"`
	HeadroomType    *HeadroomType `protobuf:"varint,4,req,name=headroom_type,json=headroomType,enum=aos.streaming.HeadroomType" json:"headroom_type,omitempty"`
	// contains filtered or unexported fields
}

func (*HeadroomAlert) Descriptor deprecated

func (*HeadroomAlert) Descriptor() ([]byte, []int)

Deprecated: Use HeadroomAlert.ProtoReflect.Descriptor instead.

func (*HeadroomAlert) GetHeadroomType

func (x *HeadroomAlert) GetHeadroomType() HeadroomType

func (*HeadroomAlert) GetIntervalSeconds

func (x *HeadroomAlert) GetIntervalSeconds() uint32

func (*HeadroomAlert) GetNodeA

func (x *HeadroomAlert) GetNodeA() string

func (*HeadroomAlert) GetNodeB

func (x *HeadroomAlert) GetNodeB() string

func (*HeadroomAlert) ProtoMessage

func (*HeadroomAlert) ProtoMessage()

func (*HeadroomAlert) ProtoReflect

func (x *HeadroomAlert) ProtoReflect() protoreflect.Message

func (*HeadroomAlert) Reset

func (x *HeadroomAlert) Reset()

func (*HeadroomAlert) String

func (x *HeadroomAlert) String() string

type HeadroomType

type HeadroomType int32
const (
	HeadroomType_HEADROOM_TYPE_MAX HeadroomType = 1
	HeadroomType_HEADROOM_TYPE_MIN HeadroomType = 2
)

func (HeadroomType) Descriptor

func (HeadroomType) Enum

func (x HeadroomType) Enum() *HeadroomType

func (HeadroomType) EnumDescriptor deprecated

func (HeadroomType) EnumDescriptor() ([]byte, []int)

Deprecated: Use HeadroomType.Descriptor instead.

func (HeadroomType) Number

func (HeadroomType) String

func (x HeadroomType) String() string

func (HeadroomType) Type

func (*HeadroomType) UnmarshalJSON deprecated

func (x *HeadroomType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type HostnameAlert

type HostnameAlert struct {
	ExpectedHostname *string `protobuf:"bytes,1,req,name=expected_hostname,json=expectedHostname" json:"expected_hostname,omitempty"`
	ActualHostname   *string `protobuf:"bytes,2,req,name=actual_hostname,json=actualHostname" json:"actual_hostname,omitempty"`
	// contains filtered or unexported fields
}

func (*HostnameAlert) Descriptor deprecated

func (*HostnameAlert) Descriptor() ([]byte, []int)

Deprecated: Use HostnameAlert.ProtoReflect.Descriptor instead.

func (*HostnameAlert) GetActualHostname

func (x *HostnameAlert) GetActualHostname() string

func (*HostnameAlert) GetExpectedHostname

func (x *HostnameAlert) GetExpectedHostname() string

func (*HostnameAlert) ProtoMessage

func (*HostnameAlert) ProtoMessage()

func (*HostnameAlert) ProtoReflect

func (x *HostnameAlert) ProtoReflect() protoreflect.Message

func (*HostnameAlert) Reset

func (x *HostnameAlert) Reset()

func (*HostnameAlert) String

func (x *HostnameAlert) String() string

type IbaDashboard

type IbaDashboard struct {
	Id        ObjectId
	CreatedAt time.Time
	UpdatedAt time.Time
	Data      *IbaDashboardData
}

type IbaDashboardData

type IbaDashboardData struct {
	Description         string
	Default             bool
	Label               string
	IbaWidgetGrid       [][]ObjectId
	PredefinedDashboard string
	UpdatedBy           string
}

type IbaPredefinedProbe

type IbaPredefinedProbe struct {
	Name         string          `json:"name"`
	Experimental bool            `json:"experimental"`
	Description  string          `json:"description"`
	Schema       json.RawMessage `json:"schema"`
}

type IbaPredefinedProbeRequest

type IbaPredefinedProbeRequest struct {
	Name string
	Data json.RawMessage
}

type IbaProbe

type IbaProbe struct {
	Id              ObjectId                 `json:"id"`
	Label           string                   `json:"label"`
	Tags            []string                 `json:"tags"`
	Stages          []map[string]interface{} `json:"stages"`
	Processors      []map[string]interface{} `json:"processors"`
	PredefinedProbe string                   `json:"predefined_probe"`
	Description     string                   `json:"description"`
}

type IbaProbeState

type IbaProbeState struct {
	Id              ObjectId                 `json:"id"`
	Label           string                   `json:"label"`
	TaskError       string                   `json:"task_error"`
	Stages          []map[string]interface{} `json:"stages"`
	Processors      []map[string]interface{} `json:"processors"`
	AnomalyCount    int                      `json:"anomaly_count"`
	Tags            []string                 `json:"tags"`
	Disabled        bool                     `json:"disabled"`
	State           string                   `json:"state"`
	Version         int                      `json:"version"`
	TaskState       string                   `json:"task_state"`
	IbaUnit         string                   `json:"iba_unit"`
	PredefinedProbe string                   `json:"predefined_probe"`
	Description     string                   `json:"description"`
}

func (*IbaProbeState) IbaProbe

func (o *IbaProbeState) IbaProbe() IbaProbe

type IbaWidget

type IbaWidget struct {
	Id        ObjectId
	CreatedAt time.Time
	UpdatedAt time.Time
	Data      *IbaWidgetData
}

type IbaWidgetData

type IbaWidgetData struct {
	AggregationPeriod  *time.Duration
	OrderBy            string
	StageName          string
	ShowContext        bool
	Description        string
	AnomalousOnly      bool
	SpotlightMode      bool
	ProbeId            ObjectId
	Label              string
	Filter             string
	TimeSeriesDuration *time.Duration
	DataSource         string
	MaxItems           *int
	CombineGraphs      string
	VisibleColumns     []string
	Type               IbaWidgetType
	UpdatedBy          string
}

type IbaWidgetType

type IbaWidgetType oenum.Member[string]

func (*IbaWidgetType) FromString

func (o *IbaWidgetType) FromString(s string) error

func (IbaWidgetType) String

func (o IbaWidgetType) String() string

type IntPool

type IntPool struct {
	Id             ObjectId
	DisplayName    string
	Ranges         IntRanges // by using the named slice type we can call IndexOf()
	Tags           []string
	Status         PoolStatus
	CreatedAt      time.Time
	LastModifiedAt time.Time
	Total          uint32
	Used           uint32
	UsedPercentage float32
}

IntPool is the public structure used to convey query responses about Int pools.

type IntPoolRequest

type IntPoolRequest struct {
	DisplayName string
	Ranges      []IntfIntRange
	Tags        []string
}

IntPoolRequest is the public structure used to create/update an Int pool.

type IntRange

type IntRange struct {
	Status         string
	First          uint32
	Last           uint32
	Total          uint32
	Used           uint32
	UsedPercentage float32
}

IntRange is the public structure found within IntPool

type IntRangeRequest

type IntRangeRequest struct {
	First uint32
	Last  uint32
}

IntRangeRequest is the public structure found within an IntPoolRequest.

type IntRanges

type IntRanges []IntRange

IntRanges is used in IntPool responses. It exists as a standalone type to facilitate checks with IndexOf() and Overlaps() methods.

func (IntRanges) IndexOf

func (o IntRanges) IndexOf(b IntfIntRange) int

IndexOf returns index of 'b'. If not found, it returns -1

func (IntRanges) Overlaps

func (o IntRanges) Overlaps(b IntfIntRange) bool

type InterfaceCounters

type InterfaceCounters struct {
	TxUnicastPackets   *uint64 `protobuf:"varint,1,req,name=tx_unicast_packets,json=txUnicastPackets" json:"tx_unicast_packets,omitempty"`
	TxBroadcastPackets *uint64 `protobuf:"varint,2,req,name=tx_broadcast_packets,json=txBroadcastPackets" json:"tx_broadcast_packets,omitempty"`
	TxMulticastPackets *uint64 `protobuf:"varint,3,req,name=tx_multicast_packets,json=txMulticastPackets" json:"tx_multicast_packets,omitempty"`
	TxBytes            *uint64 `protobuf:"varint,4,req,name=tx_bytes,json=txBytes" json:"tx_bytes,omitempty"`
	RxUnicastPackets   *uint64 `protobuf:"varint,5,req,name=rx_unicast_packets,json=rxUnicastPackets" json:"rx_unicast_packets,omitempty"`
	RxBroadcastPackets *uint64 `protobuf:"varint,6,req,name=rx_broadcast_packets,json=rxBroadcastPackets" json:"rx_broadcast_packets,omitempty"`
	RxMulticastPackets *uint64 `protobuf:"varint,7,req,name=rx_multicast_packets,json=rxMulticastPackets" json:"rx_multicast_packets,omitempty"`
	RxBytes            *uint64 `protobuf:"varint,8,req,name=rx_bytes,json=rxBytes" json:"rx_bytes,omitempty"`
	TxErrorPackets     *uint64 `protobuf:"varint,9,req,name=tx_error_packets,json=txErrorPackets" json:"tx_error_packets,omitempty"`
	TxDiscardPackets   *uint64 `protobuf:"varint,10,req,name=tx_discard_packets,json=txDiscardPackets" json:"tx_discard_packets,omitempty"`
	RxErrorPackets     *uint64 `protobuf:"varint,11,req,name=rx_error_packets,json=rxErrorPackets" json:"rx_error_packets,omitempty"`
	RxDiscardPackets   *uint64 `protobuf:"varint,12,req,name=rx_discard_packets,json=rxDiscardPackets" json:"rx_discard_packets,omitempty"`
	AlignmentErrors    *uint64 `protobuf:"varint,13,req,name=alignment_errors,json=alignmentErrors" json:"alignment_errors,omitempty"`
	FcsErrors          *uint64 `protobuf:"varint,14,req,name=fcs_errors,json=fcsErrors" json:"fcs_errors,omitempty"`
	SymbolErrors       *uint64 `protobuf:"varint,15,req,name=symbol_errors,json=symbolErrors" json:"symbol_errors,omitempty"`
	Runts              *uint64 `protobuf:"varint,16,req,name=runts" json:"runts,omitempty"`
	Giants             *uint64 `protobuf:"varint,17,req,name=giants" json:"giants,omitempty"`
	DeltaSeconds       *uint64 `protobuf:"varint,18,opt,name=delta_seconds,json=deltaSeconds,def=5" json:"delta_seconds,omitempty"`
	// contains filtered or unexported fields
}

func (*InterfaceCounters) Descriptor deprecated

func (*InterfaceCounters) Descriptor() ([]byte, []int)

Deprecated: Use InterfaceCounters.ProtoReflect.Descriptor instead.

func (*InterfaceCounters) GetAlignmentErrors

func (x *InterfaceCounters) GetAlignmentErrors() uint64

func (*InterfaceCounters) GetDeltaSeconds

func (x *InterfaceCounters) GetDeltaSeconds() uint64

func (*InterfaceCounters) GetFcsErrors

func (x *InterfaceCounters) GetFcsErrors() uint64

func (*InterfaceCounters) GetGiants

func (x *InterfaceCounters) GetGiants() uint64

func (*InterfaceCounters) GetRunts

func (x *InterfaceCounters) GetRunts() uint64

func (*InterfaceCounters) GetRxBroadcastPackets

func (x *InterfaceCounters) GetRxBroadcastPackets() uint64

func (*InterfaceCounters) GetRxBytes

func (x *InterfaceCounters) GetRxBytes() uint64

func (*InterfaceCounters) GetRxDiscardPackets

func (x *InterfaceCounters) GetRxDiscardPackets() uint64

func (*InterfaceCounters) GetRxErrorPackets

func (x *InterfaceCounters) GetRxErrorPackets() uint64

func (*InterfaceCounters) GetRxMulticastPackets

func (x *InterfaceCounters) GetRxMulticastPackets() uint64

func (*InterfaceCounters) GetRxUnicastPackets

func (x *InterfaceCounters) GetRxUnicastPackets() uint64

func (*InterfaceCounters) GetSymbolErrors

func (x *InterfaceCounters) GetSymbolErrors() uint64

func (*InterfaceCounters) GetTxBroadcastPackets

func (x *InterfaceCounters) GetTxBroadcastPackets() uint64

func (*InterfaceCounters) GetTxBytes

func (x *InterfaceCounters) GetTxBytes() uint64

func (*InterfaceCounters) GetTxDiscardPackets

func (x *InterfaceCounters) GetTxDiscardPackets() uint64

func (*InterfaceCounters) GetTxErrorPackets

func (x *InterfaceCounters) GetTxErrorPackets() uint64

func (*InterfaceCounters) GetTxMulticastPackets

func (x *InterfaceCounters) GetTxMulticastPackets() uint64

func (*InterfaceCounters) GetTxUnicastPackets

func (x *InterfaceCounters) GetTxUnicastPackets() uint64

func (*InterfaceCounters) ProtoMessage

func (*InterfaceCounters) ProtoMessage()

func (*InterfaceCounters) ProtoReflect

func (x *InterfaceCounters) ProtoReflect() protoreflect.Message

func (*InterfaceCounters) Reset

func (x *InterfaceCounters) Reset()

func (*InterfaceCounters) String

func (x *InterfaceCounters) String() string

type InterfaceCountersUtilization

type InterfaceCountersUtilization struct {
	TxUtilization            *uint64 `protobuf:"varint,1,req,name=tx_utilization,json=txUtilization" json:"tx_utilization,omitempty"`
	RxUtilization            *uint64 `protobuf:"varint,2,req,name=rx_utilization,json=rxUtilization" json:"rx_utilization,omitempty"`
	TxUnicastPps             *uint64 `protobuf:"varint,3,req,name=tx_unicast_pps,json=txUnicastPps" json:"tx_unicast_pps,omitempty"`
	TxBroadcastPps           *uint64 `protobuf:"varint,4,req,name=tx_broadcast_pps,json=txBroadcastPps" json:"tx_broadcast_pps,omitempty"`
	TxMulticastPps           *uint64 `protobuf:"varint,5,req,name=tx_multicast_pps,json=txMulticastPps" json:"tx_multicast_pps,omitempty"`
	TxBps                    *uint64 `protobuf:"varint,6,req,name=tx_bps,json=txBps" json:"tx_bps,omitempty"`
	TxErrorPps               *uint64 `protobuf:"varint,7,req,name=tx_error_pps,json=txErrorPps" json:"tx_error_pps,omitempty"`
	TxDiscardPps             *uint64 `protobuf:"varint,8,req,name=tx_discard_pps,json=txDiscardPps" json:"tx_discard_pps,omitempty"`
	RxUnicastPps             *uint64 `protobuf:"varint,9,req,name=rx_unicast_pps,json=rxUnicastPps" json:"rx_unicast_pps,omitempty"`
	RxBroadcastPps           *uint64 `protobuf:"varint,10,req,name=rx_broadcast_pps,json=rxBroadcastPps" json:"rx_broadcast_pps,omitempty"`
	RxMulticastPps           *uint64 `protobuf:"varint,11,req,name=rx_multicast_pps,json=rxMulticastPps" json:"rx_multicast_pps,omitempty"`
	RxBps                    *uint64 `protobuf:"varint,12,req,name=rx_bps,json=rxBps" json:"rx_bps,omitempty"`
	RxErrorPps               *uint64 `protobuf:"varint,13,req,name=rx_error_pps,json=rxErrorPps" json:"rx_error_pps,omitempty"`
	RxDiscardPps             *uint64 `protobuf:"varint,14,req,name=rx_discard_pps,json=rxDiscardPps" json:"rx_discard_pps,omitempty"`
	AlignmentErrorsPerSecond *uint64 `` /* 132-byte string literal not displayed */
	FcsErrorsPerSecond       *uint64 `protobuf:"varint,16,req,name=fcs_errors_per_second,json=fcsErrorsPerSecond" json:"fcs_errors_per_second,omitempty"`
	SymbolErrorsPerSecond    *uint64 `protobuf:"varint,17,req,name=symbol_errors_per_second,json=symbolErrorsPerSecond" json:"symbol_errors_per_second,omitempty"`
	RuntsPerSecond           *uint64 `protobuf:"varint,18,req,name=runts_per_second,json=runtsPerSecond" json:"runts_per_second,omitempty"`
	GiantsPerSecond          *uint64 `protobuf:"varint,19,req,name=giants_per_second,json=giantsPerSecond" json:"giants_per_second,omitempty"`
	// contains filtered or unexported fields
}

func (*InterfaceCountersUtilization) Descriptor deprecated

func (*InterfaceCountersUtilization) Descriptor() ([]byte, []int)

Deprecated: Use InterfaceCountersUtilization.ProtoReflect.Descriptor instead.

func (*InterfaceCountersUtilization) GetAlignmentErrorsPerSecond

func (x *InterfaceCountersUtilization) GetAlignmentErrorsPerSecond() uint64

func (*InterfaceCountersUtilization) GetFcsErrorsPerSecond

func (x *InterfaceCountersUtilization) GetFcsErrorsPerSecond() uint64

func (*InterfaceCountersUtilization) GetGiantsPerSecond

func (x *InterfaceCountersUtilization) GetGiantsPerSecond() uint64

func (*InterfaceCountersUtilization) GetRuntsPerSecond

func (x *InterfaceCountersUtilization) GetRuntsPerSecond() uint64

func (*InterfaceCountersUtilization) GetRxBps

func (x *InterfaceCountersUtilization) GetRxBps() uint64

func (*InterfaceCountersUtilization) GetRxBroadcastPps

func (x *InterfaceCountersUtilization) GetRxBroadcastPps() uint64

func (*InterfaceCountersUtilization) GetRxDiscardPps

func (x *InterfaceCountersUtilization) GetRxDiscardPps() uint64

func (*InterfaceCountersUtilization) GetRxErrorPps

func (x *InterfaceCountersUtilization) GetRxErrorPps() uint64

func (*InterfaceCountersUtilization) GetRxMulticastPps

func (x *InterfaceCountersUtilization) GetRxMulticastPps() uint64

func (*InterfaceCountersUtilization) GetRxUnicastPps

func (x *InterfaceCountersUtilization) GetRxUnicastPps() uint64

func (*InterfaceCountersUtilization) GetRxUtilization

func (x *InterfaceCountersUtilization) GetRxUtilization() uint64

func (*InterfaceCountersUtilization) GetSymbolErrorsPerSecond

func (x *InterfaceCountersUtilization) GetSymbolErrorsPerSecond() uint64

func (*InterfaceCountersUtilization) GetTxBps

func (x *InterfaceCountersUtilization) GetTxBps() uint64

func (*InterfaceCountersUtilization) GetTxBroadcastPps

func (x *InterfaceCountersUtilization) GetTxBroadcastPps() uint64

func (*InterfaceCountersUtilization) GetTxDiscardPps

func (x *InterfaceCountersUtilization) GetTxDiscardPps() uint64

func (*InterfaceCountersUtilization) GetTxErrorPps

func (x *InterfaceCountersUtilization) GetTxErrorPps() uint64

func (*InterfaceCountersUtilization) GetTxMulticastPps

func (x *InterfaceCountersUtilization) GetTxMulticastPps() uint64

func (*InterfaceCountersUtilization) GetTxUnicastPps

func (x *InterfaceCountersUtilization) GetTxUnicastPps() uint64

func (*InterfaceCountersUtilization) GetTxUtilization

func (x *InterfaceCountersUtilization) GetTxUtilization() uint64

func (*InterfaceCountersUtilization) ProtoMessage

func (*InterfaceCountersUtilization) ProtoMessage()

func (*InterfaceCountersUtilization) ProtoReflect

func (*InterfaceCountersUtilization) Reset

func (x *InterfaceCountersUtilization) Reset()

func (*InterfaceCountersUtilization) String

type InterfaceLinkStatusMismatchAlert

type InterfaceLinkStatusMismatchAlert struct {
	Hostname         *string     `protobuf:"bytes,1,req,name=hostname" json:"hostname,omitempty"`
	Ifname           *string     `protobuf:"bytes,2,req,name=ifname" json:"ifname,omitempty"`
	ExpectedIfstatus *LinkStatus `` /* 133-byte string literal not displayed */
	ActualIfstatus   *LinkStatus `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*InterfaceLinkStatusMismatchAlert) Descriptor deprecated

func (*InterfaceLinkStatusMismatchAlert) Descriptor() ([]byte, []int)

Deprecated: Use InterfaceLinkStatusMismatchAlert.ProtoReflect.Descriptor instead.

func (*InterfaceLinkStatusMismatchAlert) GetActualIfstatus

func (x *InterfaceLinkStatusMismatchAlert) GetActualIfstatus() LinkStatus

func (*InterfaceLinkStatusMismatchAlert) GetExpectedIfstatus

func (x *InterfaceLinkStatusMismatchAlert) GetExpectedIfstatus() LinkStatus

func (*InterfaceLinkStatusMismatchAlert) GetHostname

func (x *InterfaceLinkStatusMismatchAlert) GetHostname() string

func (*InterfaceLinkStatusMismatchAlert) GetIfname

func (*InterfaceLinkStatusMismatchAlert) ProtoMessage

func (*InterfaceLinkStatusMismatchAlert) ProtoMessage()

func (*InterfaceLinkStatusMismatchAlert) ProtoReflect

func (*InterfaceLinkStatusMismatchAlert) Reset

func (*InterfaceLinkStatusMismatchAlert) String

type InterfaceMap

type InterfaceMap struct {
	Id             ObjectId
	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *InterfaceMapData
}

type InterfaceMapData

type InterfaceMapData struct {
	LogicalDeviceId ObjectId
	DeviceProfileId ObjectId
	Label           string
	Interfaces      []InterfaceMapInterface
}

type InterfaceMapDigest

type InterfaceMapDigest struct {
	Id            ObjectId `json:"id"`
	Label         string   `json:"label"`
	LogicalDevice struct {
		Id    ObjectId `json:"id"`
		Label string   `json:"label"`
	} `json:"logical_device"`
	DeviceProfile struct {
		Id    ObjectId `json:"id"`
		Label string   `json:"label"`
	} `json:"device_profile"`
	CreatedAt      time.Time `json:"created_at"`
	LastModifiedAt time.Time `json:"last_modified_at"`
}

type InterfaceMapDigests

type InterfaceMapDigests []InterfaceMapDigest

func (*InterfaceMapDigests) SupportsDeviceProfile

func (o *InterfaceMapDigests) SupportsDeviceProfile(id ObjectId) bool

SupportsDeviceProfile returns bool indicating whether any InterfaceMapDigest in the slice indicates support for the given DeviceProfile ID

func (*InterfaceMapDigests) SupportsLogicalDevice

func (o *InterfaceMapDigests) SupportsLogicalDevice(id ObjectId) bool

SupportsLogicalDevice returns bool indicating whether any InterfaceMapDigest in the slice indicates support for the given LogicalDevice ID

type InterfaceMapInterface

type InterfaceMapInterface struct {
	Name        string
	Roles       LogicalDevicePortRoleFlags
	Mapping     InterfaceMapMapping
	ActiveState InterfaceStateActive
	Position    int
	Speed       LogicalDevicePortSpeed
	Setting     InterfaceMapInterfaceSetting
}

type InterfaceMapInterfaceSetting

type InterfaceMapInterfaceSetting struct {
	Param string `json:"param"`
}

type InterfaceMapMapping

type InterfaceMapMapping struct {
	DPPortId      int
	DPTransformId int
	DPInterfaceId int
	LDPanel       int
	LDPort        int
}

type InterfaceOperationState

type InterfaceOperationState int

func (InterfaceOperationState) Int

func (o InterfaceOperationState) Int() int

func (InterfaceOperationState) String

func (o InterfaceOperationState) String() string

type InterfaceSettingParam

type InterfaceSettingParam struct {
	Global struct {
		Breakout bool   `json:"breakout"`
		Fpc      int    `json:"fpc"`
		Pic      int    `json:"pic"`
		Port     int    `json:"port"`
		Speed    string `json:"speed"`
	} `json:"global"`
	Interface struct {
		Speed string `json:"speed"`
	} `json:"interface"`
}

func (InterfaceSettingParam) String

func (o InterfaceSettingParam) String() string

type InterfaceStateActive

type InterfaceStateActive bool

type InterfaceType

type InterfaceType int

func (InterfaceType) Int

func (o InterfaceType) Int() int

func (InterfaceType) String

func (o InterfaceType) String() string

type IntfIntRange

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

IntfIntRange allows both IntRangeRequest (sparse type created by the caller) and IntRange (detailed type sent by API) to be used in create/update methods

type IpPool

type IpPool struct {
	Id             ObjectId   `json:"id"`
	DisplayName    string     `json:"display_name"`
	Status         PoolStatus `json:"status"`
	Tags           []string   `json:"tags"`
	Used           big.Int    `json:"used"`
	Total          big.Int    `json:"total"`
	UsedPercentage float32    `json:"used_percentage"`
	CreatedAt      time.Time  `json:"created_at"`
	LastModifiedAt time.Time  `json:"last_modified_at"`
	Subnets        []IpSubnet `json:"subnets"`
}

type IpSubnet

type IpSubnet struct {
	Network        *net.IPNet
	Status         string
	Used           big.Int
	Total          big.Int
	UsedPercentage float32
}

type Ipv4Mode

type Ipv4Mode int

func (Ipv4Mode) String

func (o Ipv4Mode) String() string

type Ipv6Mode

type Ipv6Mode int

func (Ipv6Mode) String

func (o Ipv6Mode) String() string

type JobId

type JobId int

type JunosEvpnIrbMode

type JunosEvpnIrbMode oenum.Member[string]

func (*JunosEvpnIrbMode) FromString

func (o *JunosEvpnIrbMode) FromString(s string) error

func (JunosEvpnIrbMode) String

func (o JunosEvpnIrbMode) String() string

type KeyValuePair

type KeyValuePair struct {
	Key   *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
	Value *string `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValuePair) Descriptor deprecated

func (*KeyValuePair) Descriptor() ([]byte, []int)

Deprecated: Use KeyValuePair.ProtoReflect.Descriptor instead.

func (*KeyValuePair) GetKey

func (x *KeyValuePair) GetKey() string

func (*KeyValuePair) GetValue

func (x *KeyValuePair) GetValue() string

func (*KeyValuePair) ProtoMessage

func (*KeyValuePair) ProtoMessage()

func (*KeyValuePair) ProtoReflect

func (x *KeyValuePair) ProtoReflect() protoreflect.Message

func (*KeyValuePair) Reset

func (x *KeyValuePair) Reset()

func (*KeyValuePair) String

func (x *KeyValuePair) String() string

type LagAlert

type LagAlert struct {
	Hostname             *string  `protobuf:"bytes,1,req,name=hostname" json:"hostname,omitempty"`
	Lagname              *string  `protobuf:"bytes,2,req,name=lagname" json:"lagname,omitempty"`
	ExpectedIfupCount    *uint32  `protobuf:"varint,5,req,name=expected_ifup_count,json=expectedIfupCount" json:"expected_ifup_count,omitempty"`
	ActualIfupCount      *uint32  `protobuf:"varint,6,req,name=actual_ifup_count,json=actualIfupCount" json:"actual_ifup_count,omitempty"`
	ExpectedInterfacesUp []string `protobuf:"bytes,7,rep,name=expected_interfaces_up,json=expectedInterfacesUp" json:"expected_interfaces_up,omitempty"`
	ActualInterfacesUp   []string `protobuf:"bytes,8,rep,name=actual_interfaces_up,json=actualInterfacesUp" json:"actual_interfaces_up,omitempty"`
	// contains filtered or unexported fields
}

func (*LagAlert) Descriptor deprecated

func (*LagAlert) Descriptor() ([]byte, []int)

Deprecated: Use LagAlert.ProtoReflect.Descriptor instead.

func (*LagAlert) GetActualIfupCount

func (x *LagAlert) GetActualIfupCount() uint32

func (*LagAlert) GetActualInterfacesUp

func (x *LagAlert) GetActualInterfacesUp() []string

func (*LagAlert) GetExpectedIfupCount

func (x *LagAlert) GetExpectedIfupCount() uint32

func (*LagAlert) GetExpectedInterfacesUp

func (x *LagAlert) GetExpectedInterfacesUp() []string

func (*LagAlert) GetHostname

func (x *LagAlert) GetHostname() string

func (*LagAlert) GetLagname

func (x *LagAlert) GetLagname() string

func (*LagAlert) ProtoMessage

func (*LagAlert) ProtoMessage()

func (*LagAlert) ProtoReflect

func (x *LagAlert) ProtoReflect() protoreflect.Message

func (*LagAlert) Reset

func (x *LagAlert) Reset()

func (*LagAlert) String

func (x *LagAlert) String() string

type LagEvent

type LagEvent struct {
	Hostname          *string  `protobuf:"bytes,1,req,name=hostname" json:"hostname,omitempty"`
	Lagname           *string  `protobuf:"bytes,2,req,name=lagname" json:"lagname,omitempty"`
	Interfacesupcount *uint32  `protobuf:"varint,3,req,name=interfacesupcount" json:"interfacesupcount,omitempty"`
	Interfacesup      []string `protobuf:"bytes,4,rep,name=interfacesup" json:"interfacesup,omitempty"`
	// contains filtered or unexported fields
}

func (*LagEvent) Descriptor deprecated

func (*LagEvent) Descriptor() ([]byte, []int)

Deprecated: Use LagEvent.ProtoReflect.Descriptor instead.

func (*LagEvent) GetHostname

func (x *LagEvent) GetHostname() string

func (*LagEvent) GetInterfacesup

func (x *LagEvent) GetInterfacesup() []string

func (*LagEvent) GetInterfacesupcount

func (x *LagEvent) GetInterfacesupcount() uint32

func (*LagEvent) GetLagname

func (x *LagEvent) GetLagname() string

func (*LagEvent) ProtoMessage

func (*LagEvent) ProtoMessage()

func (*LagEvent) ProtoReflect

func (x *LagEvent) ProtoReflect() protoreflect.Message

func (*LagEvent) Reset

func (x *LagEvent) Reset()

func (*LagEvent) String

func (x *LagEvent) String() string

type LeafMlagInfo

type LeafMlagInfo struct {
	LeafLeafL3LinkCount         int
	LeafLeafL3LinkPortChannelId int
	LeafLeafL3LinkSpeed         LogicalDevicePortSpeed
	LeafLeafLinkCount           int
	LeafLeafLinkPortChannelId   int
	LeafLeafLinkSpeed           LogicalDevicePortSpeed
	MlagVlanId                  int
}

type LeafRedundancyProtocol

type LeafRedundancyProtocol int

func (*LeafRedundancyProtocol) FromString

func (o *LeafRedundancyProtocol) FromString(in string) error

func (LeafRedundancyProtocol) Int

func (o LeafRedundancyProtocol) Int() int

func (LeafRedundancyProtocol) String

func (o LeafRedundancyProtocol) String() string

type LinkLagParams

type LinkLagParams struct {
	GroupLabel string
	LagMode    RackLinkLagMode
	Tags       []string
}

type LinkRole

type LinkRole int

func (*LinkRole) FromString

func (o *LinkRole) FromString(s string) error

func (LinkRole) Int

func (o LinkRole) Int() int

func (LinkRole) String

func (o LinkRole) String() string

type LinkStatus

type LinkStatus int32
const (
	LinkStatus_LINK_UP      LinkStatus = 0
	LinkStatus_LINK_DOWN    LinkStatus = 1
	LinkStatus_LINK_UNKNOWN LinkStatus = 2
	LinkStatus_LINK_MISSING LinkStatus = 3
)

func (LinkStatus) Descriptor

func (LinkStatus) Descriptor() protoreflect.EnumDescriptor

func (LinkStatus) Enum

func (x LinkStatus) Enum() *LinkStatus

func (LinkStatus) EnumDescriptor deprecated

func (LinkStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use LinkStatus.Descriptor instead.

func (LinkStatus) Number

func (x LinkStatus) Number() protoreflect.EnumNumber

func (LinkStatus) String

func (x LinkStatus) String() string

func (LinkStatus) Type

func (*LinkStatus) UnmarshalJSON deprecated

func (x *LinkStatus) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type LinkStatusEvent

type LinkStatusEvent struct {
	Hostname *string     `protobuf:"bytes,1,req,name=hostname" json:"hostname,omitempty"`
	Ifname   *string     `protobuf:"bytes,2,req,name=ifname" json:"ifname,omitempty"`
	State    *LinkStatus `protobuf:"varint,3,req,name=state,enum=aos.streaming.LinkStatus" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*LinkStatusEvent) Descriptor deprecated

func (*LinkStatusEvent) Descriptor() ([]byte, []int)

Deprecated: Use LinkStatusEvent.ProtoReflect.Descriptor instead.

func (*LinkStatusEvent) GetHostname

func (x *LinkStatusEvent) GetHostname() string

func (*LinkStatusEvent) GetIfname

func (x *LinkStatusEvent) GetIfname() string

func (*LinkStatusEvent) GetState

func (x *LinkStatusEvent) GetState() LinkStatus

func (*LinkStatusEvent) ProtoMessage

func (*LinkStatusEvent) ProtoMessage()

func (*LinkStatusEvent) ProtoReflect

func (x *LinkStatusEvent) ProtoReflect() protoreflect.Message

func (*LinkStatusEvent) Reset

func (x *LinkStatusEvent) Reset()

func (*LinkStatusEvent) String

func (x *LinkStatusEvent) String() string

type LinkType

type LinkType int

func (LinkType) Int

func (o LinkType) Int() int

func (LinkType) QEEAttributee

func (o LinkType) QEEAttributee() QEEAttribute

func (LinkType) String

func (o LinkType) String() string

type LivenessAlert

type LivenessAlert struct {
	ExpectedAgents []string `protobuf:"bytes,1,rep,name=expected_agents,json=expectedAgents" json:"expected_agents,omitempty"`
	ActualAgents   []string `protobuf:"bytes,2,rep,name=actual_agents,json=actualAgents" json:"actual_agents,omitempty"`
	Alive          *bool    `protobuf:"varint,3,req,name=alive" json:"alive,omitempty"`
	// contains filtered or unexported fields
}

func (*LivenessAlert) Descriptor deprecated

func (*LivenessAlert) Descriptor() ([]byte, []int)

Deprecated: Use LivenessAlert.ProtoReflect.Descriptor instead.

func (*LivenessAlert) GetActualAgents

func (x *LivenessAlert) GetActualAgents() []string

func (*LivenessAlert) GetAlive

func (x *LivenessAlert) GetAlive() bool

func (*LivenessAlert) GetExpectedAgents

func (x *LivenessAlert) GetExpectedAgents() []string

func (*LivenessAlert) ProtoMessage

func (*LivenessAlert) ProtoMessage()

func (*LivenessAlert) ProtoReflect

func (x *LivenessAlert) ProtoReflect() protoreflect.Message

func (*LivenessAlert) Reset

func (x *LivenessAlert) Reset()

func (*LivenessAlert) String

func (x *LivenessAlert) String() string

type LockInfo

type LockInfo struct {
	UserName         string
	FirstName        string
	LastName         string
	UserId           ObjectId
	PossibleOverride bool
	LockStatus       LockStatus
}

func (*LockInfo) String

func (o *LockInfo) String() string

type LockStatus

type LockStatus int

func (LockStatus) String

func (o LockStatus) String() string

type Logger

type Logger interface {
	Println(v ...any)
}

type LogicalDevice

type LogicalDevice struct {
	Id             ObjectId
	CreatedAt      *time.Time
	LastModifiedAt *time.Time
	Data           *LogicalDeviceData
}

type LogicalDeviceData

type LogicalDeviceData struct {
	DisplayName string
	Panels      []LogicalDevicePanel
}

type LogicalDevicePanel

type LogicalDevicePanel struct {
	PanelLayout  LogicalDevicePanelLayout  `json:"panel_layout"`
	PortIndexing LogicalDevicePortIndexing `json:"port_indexing"`
	PortGroups   []LogicalDevicePortGroup  `json:"port_groups"`
}

type LogicalDevicePanelLayout

type LogicalDevicePanelLayout struct {
	RowCount    int `json:"row_count"`
	ColumnCount int `json:"column_count"`
}

type LogicalDevicePortGroup

type LogicalDevicePortGroup struct {
	Count int                        `json:"count"`
	Speed LogicalDevicePortSpeed     `json:"speed"`
	Roles LogicalDevicePortRoleFlags `json:"roles"`
}

type LogicalDevicePortIndexing

type LogicalDevicePortIndexing struct {
	Order      string `json:"order"`
	StartIndex int    `json:"start_index"`
	Schema     string `json:"schema"` // Valid choices: absolute
}

type LogicalDevicePortRoleFlags

type LogicalDevicePortRoleFlags uint16

func (*LogicalDevicePortRoleFlags) FromStrings

func (o *LogicalDevicePortRoleFlags) FromStrings(in []string) error

func (*LogicalDevicePortRoleFlags) SetAll

func (o *LogicalDevicePortRoleFlags) SetAll()

func (*LogicalDevicePortRoleFlags) Strings

func (o *LogicalDevicePortRoleFlags) Strings() []string

type LogicalDevicePortSpeed

type LogicalDevicePortSpeed string

func (LogicalDevicePortSpeed) BitsPerSecond

func (o LogicalDevicePortSpeed) BitsPerSecond() int64

func (LogicalDevicePortSpeed) IsEqual

type MacAlert

type MacAlert struct {
	Macaddress          *string  `protobuf:"bytes,1,req,name=macaddress" json:"macaddress,omitempty"`
	Intfname            *string  `protobuf:"bytes,2,req,name=intfname" json:"intfname,omitempty"`
	Vlan                *uint32  `protobuf:"varint,3,req,name=vlan" json:"vlan,omitempty"`
	Movecount           *uint32  `protobuf:"varint,4,req,name=movecount" json:"movecount,omitempty"`
	ActualMoveInterval  *float64 `protobuf:"fixed64,5,req,name=actual_move_interval,json=actualMoveInterval" json:"actual_move_interval,omitempty"`
	ExpectedMaxInterval *float64 `protobuf:"fixed64,6,req,name=expected_max_interval,json=expectedMaxInterval" json:"expected_max_interval,omitempty"`
	// contains filtered or unexported fields
}

func (*MacAlert) Descriptor deprecated

func (*MacAlert) Descriptor() ([]byte, []int)

Deprecated: Use MacAlert.ProtoReflect.Descriptor instead.

func (*MacAlert) GetActualMoveInterval

func (x *MacAlert) GetActualMoveInterval() float64

func (*MacAlert) GetExpectedMaxInterval

func (x *MacAlert) GetExpectedMaxInterval() float64

func (*MacAlert) GetIntfname

func (x *MacAlert) GetIntfname() string

func (*MacAlert) GetMacaddress

func (x *MacAlert) GetMacaddress() string

func (*MacAlert) GetMovecount

func (x *MacAlert) GetMovecount() uint32

func (*MacAlert) GetVlan

func (x *MacAlert) GetVlan() uint32

func (*MacAlert) ProtoMessage

func (*MacAlert) ProtoMessage()

func (*MacAlert) ProtoReflect

func (x *MacAlert) ProtoReflect() protoreflect.Message

func (*MacAlert) Reset

func (x *MacAlert) Reset()

func (*MacAlert) String

func (x *MacAlert) String() string

type MacEvent

type MacEvent struct {
	Macaddress *string   `protobuf:"bytes,1,req,name=macaddress" json:"macaddress,omitempty"`
	Intfname   *string   `protobuf:"bytes,2,req,name=intfname" json:"intfname,omitempty"`
	Vlan       *uint32   `protobuf:"varint,3,req,name=vlan" json:"vlan,omitempty"`
	State      *MacState `protobuf:"varint,4,req,name=state,enum=aos.streaming.MacState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*MacEvent) Descriptor deprecated

func (*MacEvent) Descriptor() ([]byte, []int)

Deprecated: Use MacEvent.ProtoReflect.Descriptor instead.

func (*MacEvent) GetIntfname

func (x *MacEvent) GetIntfname() string

func (*MacEvent) GetMacaddress

func (x *MacEvent) GetMacaddress() string

func (*MacEvent) GetState

func (x *MacEvent) GetState() MacState

func (*MacEvent) GetVlan

func (x *MacEvent) GetVlan() uint32

func (*MacEvent) ProtoMessage

func (*MacEvent) ProtoMessage()

func (*MacEvent) ProtoReflect

func (x *MacEvent) ProtoReflect() protoreflect.Message

func (*MacEvent) Reset

func (x *MacEvent) Reset()

func (*MacEvent) String

func (x *MacEvent) String() string

type MacState

type MacState int32
const (
	MacState_MAC_ADD    MacState = 0
	MacState_MAC_DELETE MacState = 1
	MacState_MAC_MOVE   MacState = 2
)

func (MacState) Descriptor

func (MacState) Descriptor() protoreflect.EnumDescriptor

func (MacState) Enum

func (x MacState) Enum() *MacState

func (MacState) EnumDescriptor deprecated

func (MacState) EnumDescriptor() ([]byte, []int)

Deprecated: Use MacState.Descriptor instead.

func (MacState) Number

func (x MacState) Number() protoreflect.EnumNumber

func (MacState) String

func (x MacState) String() string

func (MacState) Type

func (*MacState) UnmarshalJSON deprecated

func (x *MacState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ManagedSystemInfo

type ManagedSystemInfo struct {
	ContainerStatus SystemContainerStatus
	DeviceKey       string
	Facts           SystemFacts
	Id              SystemId
	Services        []string
	Status          SystemStatus
	UserConfig      SystemUserConfig
}

type MatchQuery

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

func (*MatchQuery) Distinct

func (o *MatchQuery) Distinct(distinct MatchQueryDistinct) *MatchQuery

func (*MatchQuery) Do

func (o *MatchQuery) Do(ctx context.Context, response interface{}) error

func (*MatchQuery) Match

func (o *MatchQuery) Match(q QEQuery) *MatchQuery

func (*MatchQuery) Optional

func (o *MatchQuery) Optional(q QEQuery) *MatchQuery

func (*MatchQuery) RawResult

func (o *MatchQuery) RawResult() []byte

func (*MatchQuery) SetBlueprintId

func (o *MatchQuery) SetBlueprintId(id ObjectId) *MatchQuery

func (*MatchQuery) SetBlueprintType

func (o *MatchQuery) SetBlueprintType(t BlueprintType) *MatchQuery

func (*MatchQuery) SetClient

func (o *MatchQuery) SetClient(client *Client) *MatchQuery

func (*MatchQuery) String

func (o *MatchQuery) String() string

func (*MatchQuery) Where

func (o *MatchQuery) Where(where string) *MatchQuery

type MatchQueryDistinct

type MatchQueryDistinct []string

func (MatchQueryDistinct) String

func (o MatchQueryDistinct) String() string

type MatchQueryElement

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

func (*MatchQueryElement) String

func (o *MatchQueryElement) String() string

type MetricDbQueryRequest

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

type MetricDbQueryResponse

type MetricDbQueryResponse struct {
	Status struct {
		TotalCount    int       `json:"total_count"`
		BeginTime     time.Time `json:"begin_time"`
		EndTime       time.Time `json:"end_time"`
		ResultCode    string    `json:"result_code"`
		LastTimestamp time.Time `json:"last_timestamp"`
	} `json:"status"`
	Items []json.RawMessage `json:"items"`
}

type MetricdbMetric

type MetricdbMetric struct {
	Application string `json:"application"`
	Namespace   string `json:"namespace"`
	Name        string `json:"name"`
}

type MlagAlert

type MlagAlert struct {
	Hostname               *string          `protobuf:"bytes,1,req,name=hostname" json:"hostname,omitempty"`
	DomainId               *string          `protobuf:"bytes,2,req,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	MlagId                 *uint32          `protobuf:"varint,3,req,name=mlag_id,json=mlagId" json:"mlag_id,omitempty"`
	ExpectedDomainState    *MlagDomainState `` /* 149-byte string literal not displayed */
	ActualDomainState      *MlagDomainState `` /* 143-byte string literal not displayed */
	Ifname                 *string          `protobuf:"bytes,6,req,name=ifname" json:"ifname,omitempty"`
	ExpectedIntfState      *MlagIntfState   `` /* 141-byte string literal not displayed */
	ActualIntfState        *MlagIntfState   `` /* 135-byte string literal not displayed */
	PeerLink               *string          `protobuf:"bytes,9,req,name=peer_link,json=peerLink" json:"peer_link,omitempty"`
	PeerLinkStatus         *string          `protobuf:"bytes,10,req,name=peer_link_status,json=peerLinkStatus" json:"peer_link_status,omitempty"`
	ExpectedPeerLinkStatus *string          `protobuf:"bytes,11,req,name=expected_peer_link_status,json=expectedPeerLinkStatus" json:"expected_peer_link_status,omitempty"`
	// contains filtered or unexported fields
}

func (*MlagAlert) Descriptor deprecated

func (*MlagAlert) Descriptor() ([]byte, []int)

Deprecated: Use MlagAlert.ProtoReflect.Descriptor instead.

func (*MlagAlert) GetActualDomainState

func (x *MlagAlert) GetActualDomainState() MlagDomainState

func (*MlagAlert) GetActualIntfState

func (x *MlagAlert) GetActualIntfState() MlagIntfState

func (*MlagAlert) GetDomainId

func (x *MlagAlert) GetDomainId() string

func (*MlagAlert) GetExpectedDomainState

func (x *MlagAlert) GetExpectedDomainState() MlagDomainState

func (*MlagAlert) GetExpectedIntfState

func (x *MlagAlert) GetExpectedIntfState() MlagIntfState

func (*MlagAlert) GetExpectedPeerLinkStatus

func (x *MlagAlert) GetExpectedPeerLinkStatus() string

func (*MlagAlert) GetHostname

func (x *MlagAlert) GetHostname() string

func (*MlagAlert) GetIfname

func (x *MlagAlert) GetIfname() string

func (*MlagAlert) GetMlagId

func (x *MlagAlert) GetMlagId() uint32
func (x *MlagAlert) GetPeerLink() string

func (*MlagAlert) GetPeerLinkStatus

func (x *MlagAlert) GetPeerLinkStatus() string

func (*MlagAlert) ProtoMessage

func (*MlagAlert) ProtoMessage()

func (*MlagAlert) ProtoReflect

func (x *MlagAlert) ProtoReflect() protoreflect.Message

func (*MlagAlert) Reset

func (x *MlagAlert) Reset()

func (*MlagAlert) String

func (x *MlagAlert) String() string

type MlagDomainState

type MlagDomainState int32
const (
	MlagDomainState_MLAG_UNKNOWN  MlagDomainState = 0
	MlagDomainState_MLAG_MISSING  MlagDomainState = 1
	MlagDomainState_MLAG_DISABLED MlagDomainState = 2
	MlagDomainState_MLAG_INACTIVE MlagDomainState = 3
	MlagDomainState_MLAG_ACTIVE   MlagDomainState = 4
)

func (MlagDomainState) Descriptor

func (MlagDomainState) Enum

func (x MlagDomainState) Enum() *MlagDomainState

func (MlagDomainState) EnumDescriptor deprecated

func (MlagDomainState) EnumDescriptor() ([]byte, []int)

Deprecated: Use MlagDomainState.Descriptor instead.

func (MlagDomainState) Number

func (MlagDomainState) String

func (x MlagDomainState) String() string

func (MlagDomainState) Type

func (*MlagDomainState) UnmarshalJSON deprecated

func (x *MlagDomainState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type MlagEvent

type MlagEvent struct {
	DomainId    *string          `protobuf:"bytes,1,req,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	DomainState *MlagDomainState `protobuf:"varint,2,req,name=domain_state,json=domainState,enum=aos.streaming.MlagDomainState" json:"domain_state,omitempty"`
	Intfname    *string          `protobuf:"bytes,3,req,name=intfname" json:"intfname,omitempty"`
	IntfState   *MlagIntfState   `protobuf:"varint,4,req,name=intf_state,json=intfState,enum=aos.streaming.MlagIntfState" json:"intf_state,omitempty"`
	// contains filtered or unexported fields
}

func (*MlagEvent) Descriptor deprecated

func (*MlagEvent) Descriptor() ([]byte, []int)

Deprecated: Use MlagEvent.ProtoReflect.Descriptor instead.

func (*MlagEvent) GetDomainId

func (x *MlagEvent) GetDomainId() string

func (*MlagEvent) GetDomainState

func (x *MlagEvent) GetDomainState() MlagDomainState

func (*MlagEvent) GetIntfState

func (x *MlagEvent) GetIntfState() MlagIntfState

func (*MlagEvent) GetIntfname

func (x *MlagEvent) GetIntfname() string

func (*MlagEvent) ProtoMessage

func (*MlagEvent) ProtoMessage()

func (*MlagEvent) ProtoReflect

func (x *MlagEvent) ProtoReflect() protoreflect.Message

func (*MlagEvent) Reset

func (x *MlagEvent) Reset()

func (*MlagEvent) String

func (x *MlagEvent) String() string

type MlagIntfState

type MlagIntfState int32
const (
	MlagIntfState_MLAG_INTF_UNKNOWN        MlagIntfState = 0
	MlagIntfState_MLAG_INTF_MISSING        MlagIntfState = 1
	MlagIntfState_MLAG_INTF_DISABLED       MlagIntfState = 2
	MlagIntfState_MLAG_INTF_CONFIGURED     MlagIntfState = 3
	MlagIntfState_MLAG_INTF_INACTIVE       MlagIntfState = 4
	MlagIntfState_MLAG_INTF_ACTIVE_PARTIAL MlagIntfState = 5
	MlagIntfState_MLAG_INTF_ACTIVE_FULL    MlagIntfState = 6
)

func (MlagIntfState) Descriptor

func (MlagIntfState) Enum

func (x MlagIntfState) Enum() *MlagIntfState

func (MlagIntfState) EnumDescriptor deprecated

func (MlagIntfState) EnumDescriptor() ([]byte, []int)

Deprecated: Use MlagIntfState.Descriptor instead.

func (MlagIntfState) Number

func (MlagIntfState) String

func (x MlagIntfState) String() string

func (MlagIntfState) Type

func (*MlagIntfState) UnmarshalJSON deprecated

func (x *MlagIntfState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ModularDeviceProfile

type ModularDeviceProfile struct {
	Label              string
	ChassisProfileId   ObjectId
	SlotConfigurations map[uint64]ModularDeviceSlotConfiguration
}

type ModularDeviceSlotConfiguration

type ModularDeviceSlotConfiguration struct {
	LinecardProfileId ObjectId
}

type Mutex

type Mutex interface {
	GetMessage() string
	SetMessage(string) error
	BlueprintID() ObjectId
	Lock(context.Context) error
	TryLock(context.Context) error
	Unlock(context.Context) error
}

type MutexErr

type MutexErr struct {
	LockInfo *LockInfo
	Mutex    Mutex
	// contains filtered or unexported fields
}

func (MutexErr) Error

func (o MutexErr) Error() string

type NewIpPoolRequest

type NewIpPoolRequest struct {
	DisplayName string        `json:"display_name"`
	Tags        []string      `json:"tags"`
	Subnets     []NewIpSubnet `json:"subnets"`
}

type NewIpSubnet

type NewIpSubnet struct {
	Network string `json:"network"`
}

type NextHopStatus

type NextHopStatus int32
const (
	NextHopStatus_NEXT_HOP_STATUS_UNKNOWN NextHopStatus = 0
	NextHopStatus_NEXT_HOP_STATUS_UP      NextHopStatus = 1
	NextHopStatus_NEXT_HOP_STATUS_MISSING NextHopStatus = 2
)

func (NextHopStatus) Descriptor

func (NextHopStatus) Enum

func (x NextHopStatus) Enum() *NextHopStatus

func (NextHopStatus) EnumDescriptor deprecated

func (NextHopStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use NextHopStatus.Descriptor instead.

func (NextHopStatus) Number

func (NextHopStatus) String

func (x NextHopStatus) String() string

func (NextHopStatus) Type

func (*NextHopStatus) UnmarshalJSON deprecated

func (x *NextHopStatus) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type NodeType

type NodeType int

func (NodeType) QEEAttribute

func (o NodeType) QEEAttribute() QEEAttribute

func (NodeType) String

func (o NodeType) String() string

type ObjectId

type ObjectId string

ObjectId known to Apstra for various objects/resources

func (ObjectId) ObjectId

func (o ObjectId) ObjectId() ObjectId

func (ObjectId) String

func (o ObjectId) String() string

type OverlayControlProtocol

type OverlayControlProtocol int

func AllOverlayControlProtocols

func AllOverlayControlProtocols() []OverlayControlProtocol

AllOverlayControlProtocols returns the []OverlayControlProtocol representing each supported OverlayControlProtocol

func (*OverlayControlProtocol) FromString

func (o *OverlayControlProtocol) FromString(in string) error

func (OverlayControlProtocol) Int

func (o OverlayControlProtocol) Int() int

func (OverlayControlProtocol) String

func (o OverlayControlProtocol) String() string

type PathQuery

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

func (*PathQuery) Do

func (o *PathQuery) Do(ctx context.Context, response interface{}) error

func (*PathQuery) In

func (o *PathQuery) In(attributes []QEEAttribute) *PathQuery

func (*PathQuery) Node

func (o *PathQuery) Node(attributes []QEEAttribute) *PathQuery

func (*PathQuery) Out

func (o *PathQuery) Out(attributes []QEEAttribute) *PathQuery

func (*PathQuery) RawResult

func (o *PathQuery) RawResult() []byte

func (*PathQuery) SetBlueprintId

func (o *PathQuery) SetBlueprintId(id ObjectId) *PathQuery

func (*PathQuery) SetBlueprintType

func (o *PathQuery) SetBlueprintType(t BlueprintType) *PathQuery

func (*PathQuery) SetClient

func (o *PathQuery) SetClient(client *Client) *PathQuery

func (*PathQuery) String

func (o *PathQuery) String() string

func (*PathQuery) Where

func (o *PathQuery) Where(where string) *PathQuery

type PerfMon

type PerfMon struct {

	// Types that are assignable to Data:
	//	*PerfMon_InterfaceCounters
	//	*PerfMon_SystemResourceCounters
	//	*PerfMon_Generic
	//	*PerfMon_ProbeMessage
	Data      isPerfMon_Data `protobuf_oneof:"data"`
	TimeDelta *float32       `protobuf:"fixed32,3,opt,name=time_delta,json=timeDelta" json:"time_delta,omitempty"`
	// contains filtered or unexported fields
}

func (*PerfMon) Descriptor deprecated

func (*PerfMon) Descriptor() ([]byte, []int)

Deprecated: Use PerfMon.ProtoReflect.Descriptor instead.

func (*PerfMon) GetData

func (m *PerfMon) GetData() isPerfMon_Data

func (*PerfMon) GetGeneric

func (x *PerfMon) GetGeneric() *GenericPerfmonMessage

func (*PerfMon) GetInterfaceCounters

func (x *PerfMon) GetInterfaceCounters() *InterfaceCounters

func (*PerfMon) GetProbeMessage

func (x *PerfMon) GetProbeMessage() *ProbeMessage

func (*PerfMon) GetSystemResourceCounters

func (x *PerfMon) GetSystemResourceCounters() *SysResourceCounters

func (*PerfMon) GetTimeDelta

func (x *PerfMon) GetTimeDelta() float32

func (*PerfMon) ProtoMessage

func (*PerfMon) ProtoMessage()

func (*PerfMon) ProtoReflect

func (x *PerfMon) ProtoReflect() protoreflect.Message

func (*PerfMon) Reset

func (x *PerfMon) Reset()

func (*PerfMon) String

func (x *PerfMon) String() string

type PerfMon_Generic

type PerfMon_Generic struct {
	Generic *GenericPerfmonMessage `protobuf:"bytes,4,opt,name=generic,oneof"`
}

type PerfMon_InterfaceCounters

type PerfMon_InterfaceCounters struct {
	InterfaceCounters *InterfaceCounters `protobuf:"bytes,1,opt,name=interface_counters,json=interfaceCounters,oneof"`
}

type PerfMon_ProbeMessage

type PerfMon_ProbeMessage struct {
	ProbeMessage *ProbeMessage `protobuf:"bytes,5,opt,name=probe_message,json=probeMessage,oneof"`
}

type PerfMon_SystemResourceCounters

type PerfMon_SystemResourceCounters struct {
	SystemResourceCounters *SysResourceCounters `protobuf:"bytes,2,opt,name=system_resource_counters,json=systemResourceCounters,oneof"`
}

type PlatformConfig

type PlatformConfig struct {
	ContainerEnable bool `json:"container_enable"`
}

type PlatformOS

type PlatformOS int

func AllPlatformOSes

func AllPlatformOSes() []PlatformOS

AllPlatformOSes returns the []PlatformOS representing each supported PlatformOS

func (*PlatformOS) FromString

func (o *PlatformOS) FromString(s string) error

func (PlatformOS) Int

func (o PlatformOS) Int() int

func (PlatformOS) String

func (o PlatformOS) String() string

func (PlatformOS) ValidSections

func (o PlatformOS) ValidSections() []ConfigletSection

type PlatformStatus

type PlatformStatus struct {
	JobId           JobId  `json:"job_id"`
	PlatformVersion string `json:"platform_version"`
	Platform        string `json:"platform"`
	State           string `json:"state"`
	HasCredential   bool   `json:"has_credential"`
	Error           string `json:"error"`
	CurrentTask     string `json:"current_task"`
}

type Policy

type Policy struct {
	Id   ObjectId `json:"object_id,omitempty"`
	Data *PolicyData
}

type PolicyApplicationPointData

type PolicyApplicationPointData struct {
	Id    ObjectId `json:"id"`
	Label string   `json:"label"`
	Type  string   `json:"type"` // group, internal, external, security_zone, virtual_network
}

type PolicyApplicationPointType

type PolicyApplicationPointType oenum.Member[string]

func (*PolicyApplicationPointType) FromString

func (o *PolicyApplicationPointType) FromString(s string) error

func (PolicyApplicationPointType) String

type PolicyData

type PolicyData struct {
	Enabled             bool                        `json:"enabled"`
	Label               string                      `json:"label"`
	Description         string                      `json:"description"`
	SrcApplicationPoint *PolicyApplicationPointData `json:"src_application_point"`
	DstApplicationPoint *PolicyApplicationPointData `json:"dst_application_point"`
	Rules               []PolicyRule                `json:"rules"`
	Tags                []string                    `json:"tags"`
}

type PolicyRule

type PolicyRule struct {
	Id   ObjectId
	Data *PolicyRuleData
}

type PolicyRuleAction

type PolicyRuleAction oenum.Member[string]

func (*PolicyRuleAction) FromString

func (o *PolicyRuleAction) FromString(s string) error

func (PolicyRuleAction) String

func (o PolicyRuleAction) String() string

type PolicyRuleData

type PolicyRuleData struct {
	Label             string
	Description       string
	Protocol          PolicyRuleProtocol
	Action            PolicyRuleAction
	SrcPort           PortRanges
	DstPort           PortRanges
	TcpStateQualifier *TcpStateQualifier
}

type PolicyRuleProtocol

type PolicyRuleProtocol oenum.Member[string]

func (*PolicyRuleProtocol) FromString

func (o *PolicyRuleProtocol) FromString(s string) error

func (PolicyRuleProtocol) String

func (o PolicyRuleProtocol) String() string

type PoolStatus

type PoolStatus int

func (PoolStatus) Int

func (o PoolStatus) Int() int

func (PoolStatus) String

func (o PoolStatus) String() string

type PortInfo

type PortInfo struct {
	DisplayId       int
	PanelId         int
	SlotId          int
	ConnectorType   string
	RowId           int
	Transformations []Transformation
	PortId          int
	FailureDomainId int
	ColumnId        int
}

func (*PortInfo) DefaultTransform

func (o *PortInfo) DefaultTransform() *Transformation

func (*PortInfo) Transformation

func (o *PortInfo) Transformation(desired int) (*Transformation, error)

func (*PortInfo) TransformationCandidates

func (o *PortInfo) TransformationCandidates(intfName string, intfSpeed LogicalDevicePortSpeed) map[int]Transformation

TransformationCandidates takes an interface name ("xe-0/0/1:1") and a speed, and returns a map[int]Transformation populated with candidate transformations available according to the PortInfo and keyed by the transformation ID. Only "active" transformations are returned.

type PortRange

type PortRange struct {
	First uint16
	Last  uint16
}

type PortRanges

type PortRanges []PortRange

type PrefixFilter

type PrefixFilter struct {
	Action PrefixFilterAction
	Prefix net.IPNet
	GeMask *int
	LeMask *int
}

type PrefixFilterAction

type PrefixFilterAction int

func AllPrefixFilterActions

func AllPrefixFilterActions() []PrefixFilterAction

AllPrefixFilterActions returns the []PrefixFilterAction representing each possible PrefixFilterAction

func (*PrefixFilterAction) FromString

func (o *PrefixFilterAction) FromString(in string) error

func (PrefixFilterAction) Int

func (o PrefixFilterAction) Int() int

func (PrefixFilterAction) String

func (o PrefixFilterAction) String() string

type ProbeAlert

type ProbeAlert struct {
	ExpectedInt           *int64          `protobuf:"varint,2,opt,name=expected_int,json=expectedInt" json:"expected_int,omitempty"`
	ActualInt             *int64          `protobuf:"varint,3,opt,name=actual_int,json=actualInt" json:"actual_int,omitempty"`
	ExpectedFloat         *float64        `protobuf:"fixed64,4,opt,name=expected_float,json=expectedFloat" json:"expected_float,omitempty"`
	ActualFloat           *float64        `protobuf:"fixed64,5,opt,name=actual_float,json=actualFloat" json:"actual_float,omitempty"`
	ExpectedDiscreteState *string         `protobuf:"bytes,6,opt,name=expected_discrete_state,json=expectedDiscreteState" json:"expected_discrete_state,omitempty"`
	ActualDiscreteState   *string         `protobuf:"bytes,7,opt,name=actual_discrete_state,json=actualDiscreteState" json:"actual_discrete_state,omitempty"`
	ProbeId               *string         `protobuf:"bytes,8,req,name=probe_id,json=probeId" json:"probe_id,omitempty"`
	StageName             *string         `protobuf:"bytes,9,req,name=stage_name,json=stageName" json:"stage_name,omitempty"`
	KeyValuePairs         []*KeyValuePair `protobuf:"bytes,10,rep,name=key_value_pairs,json=keyValuePairs" json:"key_value_pairs,omitempty"`
	ItemId                *string         `protobuf:"bytes,11,req,name=item_id,json=itemId" json:"item_id,omitempty"`
	ExpectedText          *string         `protobuf:"bytes,12,opt,name=expected_text,json=expectedText" json:"expected_text,omitempty"`
	ActualText            *string         `protobuf:"bytes,13,opt,name=actual_text,json=actualText" json:"actual_text,omitempty"`
	ProbeLabel            *string         `protobuf:"bytes,14,opt,name=probe_label,json=probeLabel" json:"probe_label,omitempty"`
	ExpectedIntMax        *int64          `protobuf:"varint,15,opt,name=expected_int_max,json=expectedIntMax" json:"expected_int_max,omitempty"`
	ExpectedFloatMax      *float64        `protobuf:"fixed64,16,opt,name=expected_float_max,json=expectedFloatMax" json:"expected_float_max,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeAlert) Descriptor deprecated

func (*ProbeAlert) Descriptor() ([]byte, []int)

Deprecated: Use ProbeAlert.ProtoReflect.Descriptor instead.

func (*ProbeAlert) GetActualDiscreteState

func (x *ProbeAlert) GetActualDiscreteState() string

func (*ProbeAlert) GetActualFloat

func (x *ProbeAlert) GetActualFloat() float64

func (*ProbeAlert) GetActualInt

func (x *ProbeAlert) GetActualInt() int64

func (*ProbeAlert) GetActualText

func (x *ProbeAlert) GetActualText() string

func (*ProbeAlert) GetExpectedDiscreteState

func (x *ProbeAlert) GetExpectedDiscreteState() string

func (*ProbeAlert) GetExpectedFloat

func (x *ProbeAlert) GetExpectedFloat() float64

func (*ProbeAlert) GetExpectedFloatMax

func (x *ProbeAlert) GetExpectedFloatMax() float64

func (*ProbeAlert) GetExpectedInt

func (x *ProbeAlert) GetExpectedInt() int64

func (*ProbeAlert) GetExpectedIntMax

func (x *ProbeAlert) GetExpectedIntMax() int64

func (*ProbeAlert) GetExpectedText

func (x *ProbeAlert) GetExpectedText() string

func (*ProbeAlert) GetItemId

func (x *ProbeAlert) GetItemId() string

func (*ProbeAlert) GetKeyValuePairs

func (x *ProbeAlert) GetKeyValuePairs() []*KeyValuePair

func (*ProbeAlert) GetProbeId

func (x *ProbeAlert) GetProbeId() string

func (*ProbeAlert) GetProbeLabel

func (x *ProbeAlert) GetProbeLabel() string

func (*ProbeAlert) GetStageName

func (x *ProbeAlert) GetStageName() string

func (*ProbeAlert) ProtoMessage

func (*ProbeAlert) ProtoMessage()

func (*ProbeAlert) ProtoReflect

func (x *ProbeAlert) ProtoReflect() protoreflect.Message

func (*ProbeAlert) Reset

func (x *ProbeAlert) Reset()

func (*ProbeAlert) String

func (x *ProbeAlert) String() string

type ProbeData

type ProbeData struct {
	Tags   []*Tag   `protobuf:"bytes,1,rep,name=tags" json:"tags,omitempty"`
	Fields []*Field `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeData) Descriptor deprecated

func (*ProbeData) Descriptor() ([]byte, []int)

Deprecated: Use ProbeData.ProtoReflect.Descriptor instead.

func (*ProbeData) GetFields

func (x *ProbeData) GetFields() []*Field

func (*ProbeData) GetTags

func (x *ProbeData) GetTags() []*Tag

func (*ProbeData) ProtoMessage

func (*ProbeData) ProtoMessage()

func (*ProbeData) ProtoReflect

func (x *ProbeData) ProtoReflect() protoreflect.Message

func (*ProbeData) Reset

func (x *ProbeData) Reset()

func (*ProbeData) String

func (x *ProbeData) String() string

type ProbeMessage

type ProbeMessage struct {
	Property []*ProbeProperty `protobuf:"bytes,1,rep,name=property" json:"property,omitempty"`
	// Types that are assignable to Value:
	//	*ProbeMessage_Int64Value
	//	*ProbeMessage_FloatValue
	//	*ProbeMessage_StringValue
	//	*ProbeMessage_EvpnType3RouteState
	//	*ProbeMessage_EvpnType5RouteState
	//	*ProbeMessage_InterfaceCountersUtilization
	//	*ProbeMessage_SystemInterfaceUtilization
	//	*ProbeMessage_ActiveFloodlist
	Value       isProbeMessage_Value `protobuf_oneof:"value"`
	ProbeId     *string              `protobuf:"bytes,5,req,name=probe_id,json=probeId" json:"probe_id,omitempty"`
	StageName   *string              `protobuf:"bytes,6,req,name=stage_name,json=stageName" json:"stage_name,omitempty"`
	BlueprintId *string              `protobuf:"bytes,7,req,name=blueprint_id,json=blueprintId" json:"blueprint_id,omitempty"`
	ItemId      *string              `protobuf:"bytes,8,req,name=item_id,json=itemId" json:"item_id,omitempty"`
	ProbeLabel  *string              `protobuf:"bytes,14,opt,name=probe_label,json=probeLabel" json:"probe_label,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeMessage) Descriptor deprecated

func (*ProbeMessage) Descriptor() ([]byte, []int)

Deprecated: Use ProbeMessage.ProtoReflect.Descriptor instead.

func (*ProbeMessage) GetActiveFloodlist

func (x *ProbeMessage) GetActiveFloodlist() *ActiveFloodlistEvent

func (*ProbeMessage) GetBlueprintId

func (x *ProbeMessage) GetBlueprintId() string

func (*ProbeMessage) GetEvpnType3RouteState

func (x *ProbeMessage) GetEvpnType3RouteState() *EvpnType3RouteEvent

func (*ProbeMessage) GetEvpnType5RouteState

func (x *ProbeMessage) GetEvpnType5RouteState() *EvpnType5RouteEvent

func (*ProbeMessage) GetFloatValue

func (x *ProbeMessage) GetFloatValue() float32

func (*ProbeMessage) GetInt64Value

func (x *ProbeMessage) GetInt64Value() int64

func (*ProbeMessage) GetInterfaceCountersUtilization

func (x *ProbeMessage) GetInterfaceCountersUtilization() *InterfaceCountersUtilization

func (*ProbeMessage) GetItemId

func (x *ProbeMessage) GetItemId() string

func (*ProbeMessage) GetProbeId

func (x *ProbeMessage) GetProbeId() string

func (*ProbeMessage) GetProbeLabel

func (x *ProbeMessage) GetProbeLabel() string

func (*ProbeMessage) GetProperty

func (x *ProbeMessage) GetProperty() []*ProbeProperty

func (*ProbeMessage) GetStageName

func (x *ProbeMessage) GetStageName() string

func (*ProbeMessage) GetStringValue

func (x *ProbeMessage) GetStringValue() string

func (*ProbeMessage) GetSystemInterfaceUtilization

func (x *ProbeMessage) GetSystemInterfaceUtilization() *SystemInterfaceUtilization

func (*ProbeMessage) GetValue

func (m *ProbeMessage) GetValue() isProbeMessage_Value

func (*ProbeMessage) ProtoMessage

func (*ProbeMessage) ProtoMessage()

func (*ProbeMessage) ProtoReflect

func (x *ProbeMessage) ProtoReflect() protoreflect.Message

func (*ProbeMessage) Reset

func (x *ProbeMessage) Reset()

func (*ProbeMessage) String

func (x *ProbeMessage) String() string

type ProbeMessage_ActiveFloodlist

type ProbeMessage_ActiveFloodlist struct {
	ActiveFloodlist *ActiveFloodlistEvent `protobuf:"bytes,13,opt,name=active_floodlist,json=activeFloodlist,oneof"`
}

type ProbeMessage_EvpnType3RouteState

type ProbeMessage_EvpnType3RouteState struct {
	EvpnType3RouteState *EvpnType3RouteEvent `protobuf:"bytes,9,opt,name=evpn_type3_route_state,json=evpnType3RouteState,oneof"`
}

type ProbeMessage_EvpnType5RouteState

type ProbeMessage_EvpnType5RouteState struct {
	EvpnType5RouteState *EvpnType5RouteEvent `protobuf:"bytes,10,opt,name=evpn_type5_route_state,json=evpnType5RouteState,oneof"`
}

type ProbeMessage_FloatValue

type ProbeMessage_FloatValue struct {
	FloatValue float32 `protobuf:"fixed32,3,opt,name=float_value,json=floatValue,oneof"`
}

type ProbeMessage_Int64Value

type ProbeMessage_Int64Value struct {
	Int64Value int64 `protobuf:"varint,2,opt,name=int64_value,json=int64Value,oneof"`
}

type ProbeMessage_InterfaceCountersUtilization

type ProbeMessage_InterfaceCountersUtilization struct {
	InterfaceCountersUtilization *InterfaceCountersUtilization `protobuf:"bytes,11,opt,name=interface_counters_utilization,json=interfaceCountersUtilization,oneof"`
}

type ProbeMessage_StringValue

type ProbeMessage_StringValue struct {
	StringValue string `protobuf:"bytes,4,opt,name=string_value,json=stringValue,oneof"`
}

type ProbeMessage_SystemInterfaceUtilization

type ProbeMessage_SystemInterfaceUtilization struct {
	SystemInterfaceUtilization *SystemInterfaceUtilization `protobuf:"bytes,12,opt,name=system_interface_utilization,json=systemInterfaceUtilization,oneof"`
}

type ProbeProperty

type ProbeProperty struct {
	Name *string `protobuf:"bytes,5,req,name=name" json:"name,omitempty"`
	// Value contains json encoded data
	Value *string `protobuf:"bytes,6,req,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeProperty) Descriptor deprecated

func (*ProbeProperty) Descriptor() ([]byte, []int)

Deprecated: Use ProbeProperty.ProtoReflect.Descriptor instead.

func (*ProbeProperty) GetName

func (x *ProbeProperty) GetName() string

func (*ProbeProperty) GetValue

func (x *ProbeProperty) GetValue() string

func (*ProbeProperty) ProtoMessage

func (*ProbeProperty) ProtoMessage()

func (*ProbeProperty) ProtoReflect

func (x *ProbeProperty) ProtoReflect() protoreflect.Message

func (*ProbeProperty) Reset

func (x *ProbeProperty) Reset()

func (*ProbeProperty) String

func (x *ProbeProperty) String() string

type ProcessInfo

type ProcessInfo struct {
	ProcessName *string  `protobuf:"bytes,1,req,name=process_name,json=processName" json:"process_name,omitempty"`
	CpuUser     *float32 `protobuf:"fixed32,2,req,name=cpu_user,json=cpuUser" json:"cpu_user,omitempty"`
	CpuSystem   *float32 `protobuf:"fixed32,3,req,name=cpu_system,json=cpuSystem" json:"cpu_system,omitempty"`
	MemoryUsed  *uint64  `protobuf:"varint,4,req,name=memory_used,json=memoryUsed" json:"memory_used,omitempty"`
	// contains filtered or unexported fields
}

func (*ProcessInfo) Descriptor deprecated

func (*ProcessInfo) Descriptor() ([]byte, []int)

Deprecated: Use ProcessInfo.ProtoReflect.Descriptor instead.

func (*ProcessInfo) GetCpuSystem

func (x *ProcessInfo) GetCpuSystem() float32

func (*ProcessInfo) GetCpuUser

func (x *ProcessInfo) GetCpuUser() float32

func (*ProcessInfo) GetMemoryUsed

func (x *ProcessInfo) GetMemoryUsed() uint64

func (*ProcessInfo) GetProcessName

func (x *ProcessInfo) GetProcessName() string

func (*ProcessInfo) ProtoMessage

func (*ProcessInfo) ProtoMessage()

func (*ProcessInfo) ProtoReflect

func (x *ProcessInfo) ProtoReflect() protoreflect.Message

func (*ProcessInfo) Reset

func (x *ProcessInfo) Reset()

func (*ProcessInfo) String

func (x *ProcessInfo) String() string

type PropertySet

type PropertySet struct {
	Id        ObjectId
	CreatedAt time.Time
	UpdatedAt time.Time
	Data      *PropertySetData
}

type PropertySetData

type PropertySetData struct {
	Label      string          `json:"label"`
	Values     json.RawMessage `json:"values"`
	Blueprints []ObjectId      `json:"blueprints,omitempty"`
}

type QEAttrVal

type QEAttrVal interface {
	String() string
}

type QEBoolVal

type QEBoolVal bool

func (QEBoolVal) String

func (o QEBoolVal) String() string

type QEEAttribute

type QEEAttribute struct {
	Key   string
	Value QEAttrVal
}

func (QEEAttribute) String

func (o QEEAttribute) String() string

type QEEType

type QEEType int

type QEElement

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

func (*QEElement) String

func (o *QEElement) String() string

type QEIntGreater

type QEIntGreater int

func (QEIntGreater) String

func (o QEIntGreater) String() string

type QEIntGreaterEqual

type QEIntGreaterEqual int

func (QEIntGreaterEqual) String

func (o QEIntGreaterEqual) String() string

type QEIntLessThan

type QEIntLessThan int

func (QEIntLessThan) String

func (o QEIntLessThan) String() string

type QEIntLessThanEqual

type QEIntLessThanEqual int

func (QEIntLessThanEqual) String

func (o QEIntLessThanEqual) String() string

type QEIntVal

type QEIntVal int

func (QEIntVal) String

func (o QEIntVal) String() string

type QENone

type QENone bool

func (QENone) String

func (o QENone) String() string

type QEQuery

type QEQuery interface {
	Do(context.Context, interface{}) error
	String() string
	RawResult() []byte
	// contains filtered or unexported methods
}

type QEStringVal

type QEStringVal string

func (QEStringVal) String

func (o QEStringVal) String() string

type QEStringValIsIn

type QEStringValIsIn []string

func (QEStringValIsIn) String

func (o QEStringValIsIn) String() string

type QEStringValNotIn

type QEStringValNotIn []string

func (QEStringValNotIn) String

func (o QEStringValNotIn) String() string

type QueryEngineResponse

type QueryEngineResponse []json.RawMessage

type RackBasedTemplateCount

type RackBasedTemplateCount struct {
	RackBasedTemplateId ObjectId `json:"rack_based_template_id"`
	Count               int      `json:"count"`
}

type RackElementAccessSwitch

type RackElementAccessSwitch struct {
	InstanceCount      int
	RedundancyProtocol AccessRedundancyProtocol
	Links              []RackLink
	Label              string
	Tags               []DesignTagData
	LogicalDevice      *LogicalDeviceData
	EsiLagInfo         *EsiLagInfo
}

type RackElementAccessSwitchRequest

type RackElementAccessSwitchRequest struct {
	InstanceCount      int
	RedundancyProtocol AccessRedundancyProtocol
	Links              []RackLinkRequest
	Label              string
	LogicalDeviceId    ObjectId
	Tags               []ObjectId
	EsiLagInfo         *EsiLagInfo
}

type RackElementGenericSystem

type RackElementGenericSystem struct {
	Count            int
	AsnDomain        FeatureSwitch
	ManagementLevel  SystemManagementLevel
	PortChannelIdMin int
	PortChannelIdMax int
	Loopback         FeatureSwitch
	Tags             []DesignTagData
	Label            string
	Links            []RackLink
	LogicalDevice    *LogicalDeviceData
}

type RackElementGenericSystemRequest

type RackElementGenericSystemRequest struct {
	Count            int
	AsnDomain        FeatureSwitch
	ManagementLevel  SystemManagementLevel
	PortChannelIdMin int
	PortChannelIdMax int
	Loopback         FeatureSwitch
	Tags             []ObjectId
	Label            string
	Links            []RackLinkRequest
	LogicalDeviceId  ObjectId
}

type RackElementLeafSwitch

type RackElementLeafSwitch struct {
	Label              string
	LinkPerSpineCount  int
	LinkPerSpineSpeed  LogicalDevicePortSpeed
	MlagInfo           *LeafMlagInfo
	RedundancyProtocol LeafRedundancyProtocol
	Tags               []DesignTagData
	LogicalDevice      *LogicalDeviceData
}

type RackElementLeafSwitchRequest

type RackElementLeafSwitchRequest struct {
	Label              string
	MlagInfo           *LeafMlagInfo
	LinkPerSpineCount  int
	LinkPerSpineSpeed  LogicalDevicePortSpeed
	RedundancyProtocol LeafRedundancyProtocol
	Tags               []ObjectId
	LogicalDeviceId    ObjectId
}
type RackLink struct {
	Label              string
	LinkPerSwitchCount int
	LinkSpeed          LogicalDevicePortSpeed
	TargetSwitchLabel  string
	AttachmentType     RackLinkAttachmentType
	LagMode            RackLinkLagMode
	SwitchPeer         RackLinkSwitchPeer
	Tags               []DesignTagData
}

type RackLinkAttachmentType

type RackLinkAttachmentType int

func (RackLinkAttachmentType) Int

func (o RackLinkAttachmentType) Int() int

func (RackLinkAttachmentType) String

func (o RackLinkAttachmentType) String() string

type RackLinkLagMode

type RackLinkLagMode int

func (*RackLinkLagMode) FromString

func (o *RackLinkLagMode) FromString(in string) error

func (RackLinkLagMode) Int

func (o RackLinkLagMode) Int() int

func (RackLinkLagMode) String

func (o RackLinkLagMode) String() string

type RackLinkRequest

type RackLinkRequest struct {
	Label              string                 // `json:"label"`
	Tags               []ObjectId             // `json:"tags"`
	LinkPerSwitchCount int                    // `json:"link_per_switch_count"`
	LinkSpeed          LogicalDevicePortSpeed // `json:"link_speed"`
	TargetSwitchLabel  string                 // `json:"target_switch_label"`
	AttachmentType     RackLinkAttachmentType // `json:"attachment_type"`
	LagMode            RackLinkLagMode        // `json:"lag_mode"`
	SwitchPeer         RackLinkSwitchPeer     // `json:"switch_peer"`
}

type RackLinkSwitchPeer

type RackLinkSwitchPeer int

func (*RackLinkSwitchPeer) FromString

func (o *RackLinkSwitchPeer) FromString(in string) error

func (RackLinkSwitchPeer) Int

func (o RackLinkSwitchPeer) Int() int

func (RackLinkSwitchPeer) String

func (o RackLinkSwitchPeer) String() string

type RackType

type RackType struct {
	Id             ObjectId
	CreatedAt      *time.Time
	LastModifiedAt *time.Time
	Data           *RackTypeData
}

type RackTypeCount

type RackTypeCount struct {
	RackTypeId ObjectId `json:"rack_type_id"`
	Count      int      `json:"count"`
}

type RackTypeData

type RackTypeData struct {
	DisplayName              string
	Description              string
	FabricConnectivityDesign FabricConnectivityDesign
	LeafSwitches             []RackElementLeafSwitch
	GenericSystems           []RackElementGenericSystem
	AccessSwitches           []RackElementAccessSwitch
}

type RackTypeRequest

type RackTypeRequest struct {
	DisplayName              string
	Description              string
	FabricConnectivityDesign FabricConnectivityDesign
	LeafSwitches             []RackElementLeafSwitchRequest
	AccessSwitches           []RackElementAccessSwitchRequest
	GenericSystems           []RackElementGenericSystemRequest
}

type RawQuery

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

func (*RawQuery) Do

func (o *RawQuery) Do(ctx context.Context, response interface{}) error

func (*RawQuery) RawResult

func (o *RawQuery) RawResult() []byte

func (*RawQuery) SetBlueprintId

func (o *RawQuery) SetBlueprintId(id ObjectId) *RawQuery

func (*RawQuery) SetBlueprintType

func (o *RawQuery) SetBlueprintType(t BlueprintType) *RawQuery

func (*RawQuery) SetClient

func (o *RawQuery) SetClient(client *Client) *RawQuery

func (*RawQuery) SetQuery

func (o *RawQuery) SetQuery(query string) *RawQuery

func (*RawQuery) String

func (o *RawQuery) String() string

type RefDesign

type RefDesign int

func (*RefDesign) FromString

func (o *RefDesign) FromString(s string) error

func (RefDesign) String

func (o RefDesign) String() string

type RelationshipType

type RelationshipType int

func (RelationshipType) QEEAttribute

func (o RelationshipType) QEEAttribute() QEEAttribute

func (RelationshipType) String

func (o RelationshipType) String() string

type RemoteGateway

type RemoteGateway struct {
	Id   ObjectId
	Data *RemoteGatewayData
}

type RemoteGatewayData

type RemoteGatewayData struct {
	RouteTypes     RemoteGatewayRouteTypes
	LocalGwNodes   []ObjectId
	GwAsn          uint32
	GwIp           net.IP
	GwName         string
	Ttl            *uint8
	KeepaliveTimer *uint16
	HoldtimeTimer  *uint16
	Password       *string
}

type RemoteGatewayRouteTypes

type RemoteGatewayRouteTypes oenum.Member[string]

func (*RemoteGatewayRouteTypes) FromString

func (o *RemoteGatewayRouteTypes) FromString(s string) error

func (RemoteGatewayRouteTypes) String

func (o RemoteGatewayRouteTypes) String() string

type ResourceGroup

type ResourceGroup struct {
	Type           ResourceType
	Name           ResourceGroupName
	SecurityZoneId *ObjectId
}

type ResourceGroupAllocation

type ResourceGroupAllocation struct {
	ResourceGroup ResourceGroup
	PoolIds       []ObjectId `json:"pool_ids"`
}

func (*ResourceGroupAllocation) IsEmpty

func (o *ResourceGroupAllocation) IsEmpty() bool

type ResourceGroupAllocations

type ResourceGroupAllocations []ResourceGroupAllocation

func (ResourceGroupAllocations) Get

Get returns the ResourceGroupAllocation for the requested ResourceGroup, or nil if no matching ResourceGroupAllocation exists in this ResourceGroupAllocations

type ResourceGroupName

type ResourceGroupName int

func AllResourceGroupNames

func AllResourceGroupNames() []ResourceGroupName

AllResourceGroupNames returns the []ResourceGroupName representing all supported ResourceGroupName

func (*ResourceGroupName) FromString

func (o *ResourceGroupName) FromString(in string) error

func (ResourceGroupName) Int

func (o ResourceGroupName) Int() int

func (ResourceGroupName) String

func (o ResourceGroupName) String() string

func (*ResourceGroupName) Type

func (o *ResourceGroupName) Type() ResourceType

type ResourceType

type ResourceType int

func AllResourceTypes

func AllResourceTypes() []ResourceType

AllResourceTypes returns the []ResourceType representing all supported ResourceType

func (*ResourceType) FromString

func (o *ResourceType) FromString(in string) error

func (ResourceType) Int

func (o ResourceType) Int() int

func (ResourceType) String

func (o ResourceType) String() string

type RouteAlert

type RouteAlert struct {
	Ip                 *string           `protobuf:"bytes,1,req,name=ip" json:"ip,omitempty"`
	ExpectedDestStatus *RouteEntryStatus `` /* 147-byte string literal not displayed */
	ActualDestStatus   *RouteEntryStatus `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RouteAlert) Descriptor deprecated

func (*RouteAlert) Descriptor() ([]byte, []int)

Deprecated: Use RouteAlert.ProtoReflect.Descriptor instead.

func (*RouteAlert) GetActualDestStatus

func (x *RouteAlert) GetActualDestStatus() RouteEntryStatus

func (*RouteAlert) GetExpectedDestStatus

func (x *RouteAlert) GetExpectedDestStatus() RouteEntryStatus

func (*RouteAlert) GetIp

func (x *RouteAlert) GetIp() string

func (*RouteAlert) ProtoMessage

func (*RouteAlert) ProtoMessage()

func (*RouteAlert) ProtoReflect

func (x *RouteAlert) ProtoReflect() protoreflect.Message

func (*RouteAlert) Reset

func (x *RouteAlert) Reset()

func (*RouteAlert) String

func (x *RouteAlert) String() string

type RouteEntryStatus

type RouteEntryStatus int32
const (
	RouteEntryStatus_ROUTE_ENTRY_STATUS_UNKNOWN RouteEntryStatus = 0
	RouteEntryStatus_ROUTE_ENTRY_STATUS_UP      RouteEntryStatus = 1
	RouteEntryStatus_ROUTE_ENTRY_STATUS_PARTIAL RouteEntryStatus = 2
	RouteEntryStatus_ROUTE_ENTRY_STATUS_MISSING RouteEntryStatus = 3
)

func (RouteEntryStatus) Descriptor

func (RouteEntryStatus) Enum

func (RouteEntryStatus) EnumDescriptor deprecated

func (RouteEntryStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use RouteEntryStatus.Descriptor instead.

func (RouteEntryStatus) Number

func (RouteEntryStatus) String

func (x RouteEntryStatus) String() string

func (RouteEntryStatus) Type

func (*RouteEntryStatus) UnmarshalJSON deprecated

func (x *RouteEntryStatus) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type RouteEvent

type RouteEvent struct {
	DestNetwork *string           `protobuf:"bytes,1,req,name=dest_network,json=destNetwork" json:"dest_network,omitempty"`
	Status      *RouteEntryStatus `protobuf:"varint,2,req,name=status,enum=aos.streaming.RouteEntryStatus" json:"status,omitempty"`
	Hostname    *string           `protobuf:"bytes,3,req,name=hostname" json:"hostname,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteEvent) Descriptor deprecated

func (*RouteEvent) Descriptor() ([]byte, []int)

Deprecated: Use RouteEvent.ProtoReflect.Descriptor instead.

func (*RouteEvent) GetDestNetwork

func (x *RouteEvent) GetDestNetwork() string

func (*RouteEvent) GetHostname

func (x *RouteEvent) GetHostname() string

func (*RouteEvent) GetStatus

func (x *RouteEvent) GetStatus() RouteEntryStatus

func (*RouteEvent) ProtoMessage

func (*RouteEvent) ProtoMessage()

func (*RouteEvent) ProtoReflect

func (x *RouteEvent) ProtoReflect() protoreflect.Message

func (*RouteEvent) Reset

func (x *RouteEvent) Reset()

func (*RouteEvent) String

func (x *RouteEvent) String() string

type RouteState

type RouteState int32
const (
	RouteState_ROUTE_ADD    RouteState = 0
	RouteState_ROUTE_DELETE RouteState = 1
)

func (RouteState) Descriptor

func (RouteState) Descriptor() protoreflect.EnumDescriptor

func (RouteState) Enum

func (x RouteState) Enum() *RouteState

func (RouteState) EnumDescriptor deprecated

func (RouteState) EnumDescriptor() ([]byte, []int)

Deprecated: Use RouteState.Descriptor instead.

func (RouteState) Number

func (x RouteState) Number() protoreflect.EnumNumber

func (RouteState) String

func (x RouteState) String() string

func (RouteState) Type

func (*RouteState) UnmarshalJSON deprecated

func (x *RouteState) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type RouteType

type RouteType int32
const (
	RouteType_ROUTE_TYPE_UNKNOWN RouteType = 0
	RouteType_ROUTE_TYPE_DIRECT  RouteType = 1
	RouteType_ROUTE_TYPE_BGP     RouteType = 2
	RouteType_ROUTE_TYPE_STAT    RouteType = 3
)

func (RouteType) Descriptor

func (RouteType) Descriptor() protoreflect.EnumDescriptor

func (RouteType) Enum

func (x RouteType) Enum() *RouteType

func (RouteType) EnumDescriptor deprecated

func (RouteType) EnumDescriptor() ([]byte, []int)

Deprecated: Use RouteType.Descriptor instead.

func (RouteType) Number

func (x RouteType) Number() protoreflect.EnumNumber

func (RouteType) String

func (x RouteType) String() string

func (RouteType) Type

func (*RouteType) UnmarshalJSON deprecated

func (x *RouteType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type RtPolicy

type RtPolicy struct {
	ImportRTs []string `json:"import_RTs"`
	ExportRTs []string `json:"export_RTs"`
}

type SecurityZone

type SecurityZone struct {
	Id   ObjectId
	Data *SecurityZoneData
}

type SecurityZoneData

type SecurityZoneData struct {
	Label   string
	SzType  SecurityZoneType
	VrfName string

	RoutingPolicyId  ObjectId          // automatically assigned
	RouteTarget      *string           // can be null
	RtPolicy         *RtPolicy         // can be null
	VlanId           *Vlan             // can be null
	VniId            *int              // can be null
	JunosEvpnIrbMode *JunosEvpnIrbMode // Apstra 4.2+ only
}

type SecurityZoneType

type SecurityZoneType int

func (*SecurityZoneType) FromString

func (o *SecurityZoneType) FromString(in string) error

func (SecurityZoneType) Int

func (o SecurityZoneType) Int() int

func (SecurityZoneType) String

func (o SecurityZoneType) String() string

type SetLinkLagParamsRequest

type SetLinkLagParamsRequest map[ObjectId]LinkLagParams

SetLinkLagParamsRequest is a map of LAG parameters keyed by link node ID

type SoftwareCapabilities

type SoftwareCapabilities struct {
	Onie               bool   `json:"onie"`
	ConfigApplySupport string `json:"config_apply_support"`
	LxcSupport         bool   `json:"lxc_support"`
}

type Spine

type Spine struct {
	Count                  int
	LinkPerSuperspineSpeed LogicalDevicePortSpeed
	LogicalDevice          LogicalDeviceData
	LinkPerSuperspineCount int
	Tags                   []DesignTagData
}

type StreamTarget

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

StreamTarget is a listener for AOS streaming objects

func NewStreamTarget

func NewStreamTarget(cfg *StreamTargetCfg) (*StreamTarget, error)

NewStreamTarget creates a StreamTarget (socket listener) either with TLS support (when both x509Cert and privkey are supplied) or using bare TCP (when either x509Cert or privkey are nil)

func (*StreamTarget) Id

func (o *StreamTarget) Id() ObjectId

Id returns the StreamTarget ID returned by Apstra during registration or "" if unregistered.

func (*StreamTarget) Register

func (o *StreamTarget) Register(ctx context.Context, client *Client) error

Register registers this StreamTarget as a streaming config / receiver on the AOS server. If o.cfg.AosTargetHostname is non-empty, that value will be told to AOS when configuring the streaming config / receiver. If it's empty, we attempt to determine the local IP nearest to the AOS server, use that value (as a string)

func (*StreamTarget) Start

func (o *StreamTarget) Start() (msgChan <-chan *StreamingMessage, errChan <-chan error, err error)

Start loops forever handling new connections from the AOS streaming service as they arrive. Messages generated by socket clients are sent to msgChan. Receive errors are sent to errChan. An error is returned immediately if there's a problem starting the client handling loop.

func (*StreamTarget) Stop

func (o *StreamTarget) Stop()

Stop shuts down the receiver

func (*StreamTarget) Unregister

func (o *StreamTarget) Unregister(ctx context.Context) error

Unregister deletes the streaming config / receiver associated with this StreamTarget from the AOS server.

type StreamTargetCfg

type StreamTargetCfg struct {
	Certificate       *x509.Certificate
	Key               *rsa.PrivateKey
	SequencingMode    string
	StreamingType     string
	Protocol          string
	Port              uint16
	AosTargetHostname string
	TlsConfig         *tls.Config
}

StreamTargetCfg is used when initializing an instance of StreamTarget with NewStreamTarget. If Cert or Key are nil, the StreamTarget will use bare TCP rather than TLS.

type StreamingAlert

type StreamingAlert struct {
	AosServer      *string                  `protobuf:"bytes,1,req,name=aos_server,json=aosServer" json:"aos_server,omitempty"` // hostname of AOS-server
	StreamingType  *StreamingType           ``                                                                                  /* 127-byte string literal not displayed */
	Protocol       *StreamingProtocol       `protobuf:"varint,3,req,name=protocol,enum=aos.streaming.StreamingProtocol" json:"protocol,omitempty"`
	Reason         *StreamingAlertReason    `protobuf:"varint,4,req,name=reason,enum=aos.streaming.StreamingAlertReason" json:"reason,omitempty"`
	SequencingMode *StreamingSequencingMode `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StreamingAlert) Descriptor deprecated

func (*StreamingAlert) Descriptor() ([]byte, []int)

Deprecated: Use StreamingAlert.ProtoReflect.Descriptor instead.

func (*StreamingAlert) GetAosServer

func (x *StreamingAlert) GetAosServer() string

func (*StreamingAlert) GetProtocol

func (x *StreamingAlert) GetProtocol() StreamingProtocol

func (*StreamingAlert) GetReason

func (x *StreamingAlert) GetReason() StreamingAlertReason

func (*StreamingAlert) GetSequencingMode

func (x *StreamingAlert) GetSequencingMode() StreamingSequencingMode

func (*StreamingAlert) GetStreamingType

func (x *StreamingAlert) GetStreamingType() StreamingType

func (*StreamingAlert) ProtoMessage

func (*StreamingAlert) ProtoMessage()

func (*StreamingAlert) ProtoReflect

func (x *StreamingAlert) ProtoReflect() protoreflect.Message

func (*StreamingAlert) Reset

func (x *StreamingAlert) Reset()

func (*StreamingAlert) String

func (x *StreamingAlert) String() string

type StreamingAlertReason

type StreamingAlertReason int32
const (
	StreamingAlertReason_STREAMING_ALERT_REASON_FAILED_CONNECTION StreamingAlertReason = 0
	StreamingAlertReason_STREAMING_ALERT_REASON_TIMEOUT           StreamingAlertReason = 1
	StreamingAlertReason_STREAMING_ALERT_REASON_DNS_FAILURE       StreamingAlertReason = 2
	StreamingAlertReason_STREAMING_ALERT_REASON_WRITE_TIMEOUT     StreamingAlertReason = 3
)

func (StreamingAlertReason) Descriptor

func (StreamingAlertReason) Enum

func (StreamingAlertReason) EnumDescriptor deprecated

func (StreamingAlertReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamingAlertReason.Descriptor instead.

func (StreamingAlertReason) Number

func (StreamingAlertReason) String

func (x StreamingAlertReason) String() string

func (StreamingAlertReason) Type

func (*StreamingAlertReason) UnmarshalJSON deprecated

func (x *StreamingAlertReason) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type StreamingConfigInfo

type StreamingConfigInfo struct {
	Status struct {
		ConnectionLog []struct {
			Date    string `json:"date"`
			Message string `json:"message"`
		} `json:"connectionLog"`
		ConnectionTime       string                `json:"connectionTime"`
		Epoch                string                `json:"epoch"`
		ConnectionResetCount int                   `json:"connectionResetCount"`
		StreamingEndpoint    StreamingConfigParams `json:"streamingEndpoint"`
		DnsLog               []struct {
			Date    string `json:"date"`
			Message string `json:"message"`
		} `json:"dnsLog"`
		Connected         bool   `json:"connected"`
		DisconnectionTime string `json:"disconnectionTime"`
	} `json:"status"`
	StreamingType  string   `json:"streaming_type"`
	SequencingMode string   `json:"sequencing_mode"`
	Protocol       string   `json:"protocol"`
	Hostname       string   `json:"hostname"`
	Id             ObjectId `json:"id"`
	Port           uint16   `json:"port"`
}

StreamingConfigInfo is returned by Apstra in response to both:

  • 'GET apiUrlStreamingConfig' (as a member of list 'Items')
  • 'GET apiUrlStreamingConfigPrefix + {id}'

type StreamingConfigParams

type StreamingConfigParams struct {
	StreamingType  string `json:"streaming_type"`
	SequencingMode string `json:"sequencing_mode"`
	Protocol       string `json:"protocol"`
	Hostname       string `json:"hostname"`
	Port           uint16 `json:"port"`
}

StreamingConfigParams is the minimally required description needed to create, compare, and look up an Apstra streaming config / receiver.

type StreamingEvent

type StreamingEvent struct {
	AosServer      *string                  `protobuf:"bytes,1,req,name=aos_server,json=aosServer" json:"aos_server,omitempty"` // hostname of AOS-server
	StreamingType  *StreamingType           ``                                                                                  /* 127-byte string literal not displayed */
	Protocol       *StreamingProtocol       `protobuf:"varint,3,req,name=protocol,enum=aos.streaming.StreamingProtocol" json:"protocol,omitempty"`
	Status         *StreamingStatus         `protobuf:"varint,4,req,name=status,enum=aos.streaming.StreamingStatus" json:"status,omitempty"`
	SequencingMode *StreamingSequencingMode `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StreamingEvent) Descriptor deprecated

func (*StreamingEvent) Descriptor() ([]byte, []int)

Deprecated: Use StreamingEvent.ProtoReflect.Descriptor instead.

func (*StreamingEvent) GetAosServer

func (x *StreamingEvent) GetAosServer() string

func (*StreamingEvent) GetProtocol

func (x *StreamingEvent) GetProtocol() StreamingProtocol

func (*StreamingEvent) GetSequencingMode

func (x *StreamingEvent) GetSequencingMode() StreamingSequencingMode

func (*StreamingEvent) GetStatus

func (x *StreamingEvent) GetStatus() StreamingStatus

func (*StreamingEvent) GetStreamingType

func (x *StreamingEvent) GetStreamingType() StreamingType

func (*StreamingEvent) ProtoMessage

func (*StreamingEvent) ProtoMessage()

func (*StreamingEvent) ProtoReflect

func (x *StreamingEvent) ProtoReflect() protoreflect.Message

func (*StreamingEvent) Reset

func (x *StreamingEvent) Reset()

func (*StreamingEvent) String

func (x *StreamingEvent) String() string

type StreamingMessage

type StreamingMessage struct {
	SequencingMode string
	StreamingType  string
	Message        *AosMessage
	SequenceNum    *uint64
}

StreamingMessage is a wrapper structure for messages delivered by both StreamingConfigSequencingModeSequenced channels and by StreamingConfigSequencingModeUnsequenced channels. In the latter case, 'seq' will always be nil.

type StreamingProtocol

type StreamingProtocol int32
const (
	StreamingProtocol_STREAMING_PROTOCOL_PROTOBUF_OVER_TCP StreamingProtocol = 0
)

func (StreamingProtocol) Descriptor

func (StreamingProtocol) Enum

func (StreamingProtocol) EnumDescriptor deprecated

func (StreamingProtocol) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamingProtocol.Descriptor instead.

func (StreamingProtocol) Number

func (StreamingProtocol) String

func (x StreamingProtocol) String() string

func (StreamingProtocol) Type

func (*StreamingProtocol) UnmarshalJSON deprecated

func (x *StreamingProtocol) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type StreamingSequencingMode

type StreamingSequencingMode int32
const (
	StreamingSequencingMode_STREAMING_UNSEQUENCED StreamingSequencingMode = 0
	StreamingSequencingMode_STREAMING_SEQUENCED   StreamingSequencingMode = 1
)

func (StreamingSequencingMode) Descriptor

func (StreamingSequencingMode) Enum

func (StreamingSequencingMode) EnumDescriptor deprecated

func (StreamingSequencingMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamingSequencingMode.Descriptor instead.

func (StreamingSequencingMode) Number

func (StreamingSequencingMode) String

func (x StreamingSequencingMode) String() string

func (StreamingSequencingMode) Type

func (*StreamingSequencingMode) UnmarshalJSON deprecated

func (x *StreamingSequencingMode) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type StreamingStatus

type StreamingStatus int32
const (
	StreamingStatus_STREAMING_STATUS_UP   StreamingStatus = 0
	StreamingStatus_STREAMING_STATUS_DOWN StreamingStatus = 1
)

func (StreamingStatus) Descriptor

func (StreamingStatus) Enum

func (x StreamingStatus) Enum() *StreamingStatus

func (StreamingStatus) EnumDescriptor deprecated

func (StreamingStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamingStatus.Descriptor instead.

func (StreamingStatus) Number

func (StreamingStatus) String

func (x StreamingStatus) String() string

func (StreamingStatus) Type

func (*StreamingStatus) UnmarshalJSON deprecated

func (x *StreamingStatus) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type StreamingType

type StreamingType int32
const (
	StreamingType_STREAMING_TYPE_PERFMON StreamingType = 0
	StreamingType_STREAMING_TYPE_EVENTS  StreamingType = 1
	StreamingType_STREAMING_TYPE_ALERTS  StreamingType = 2
)

func (StreamingType) Descriptor

func (StreamingType) Enum

func (x StreamingType) Enum() *StreamingType

func (StreamingType) EnumDescriptor deprecated

func (StreamingType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamingType.Descriptor instead.

func (StreamingType) Number

func (StreamingType) String

func (x StreamingType) String() string

func (StreamingType) Type

func (*StreamingType) UnmarshalJSON deprecated

func (x *StreamingType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type StringSliceWithIncludes

type StringSliceWithIncludes []string

func (StringSliceWithIncludes) Includes

func (o StringSliceWithIncludes) Includes(s string) bool

type Superspine

type Superspine struct {
	PlaneCount         int
	Tags               []DesignTagData
	SuperspinePerPlane int
	LogicalDevice      LogicalDeviceData
}

type SviIp

type SviIp struct {
	SystemId        ObjectId         `json:"system_id"`
	Ipv4Addr        net.IP           `json:"ipv4_addr"`
	Ipv4Mode        Ipv4Mode         `json:"ipv4_mode"`
	Ipv4Requirement SviIpRequirement `json:"ipv4_requirement"`
	Ipv6Addr        net.IP           `json:"ipv6_addr"`
	Ipv6Mode        Ipv6Mode         `json:"ipv6_mode"`
	Ipv6Requirement SviIpRequirement `json:"ipv6_requirement"`
}

type SviIpRequirement

type SviIpRequirement int

func (SviIpRequirement) String

func (o SviIpRequirement) String() string

type SwitchLinkEndpoint

type SwitchLinkEndpoint struct {
	TransformationId int
	SystemId         ObjectId
	IfName           string
}

type SysResourceCounters

type SysResourceCounters struct {
	SystemInfo  *SystemInfo    `protobuf:"bytes,1,opt,name=system_info,json=systemInfo" json:"system_info,omitempty"`
	ProcessInfo []*ProcessInfo `protobuf:"bytes,2,rep,name=process_info,json=processInfo" json:"process_info,omitempty"`
	FileInfo    []*FileInfo    `protobuf:"bytes,3,rep,name=file_info,json=fileInfo" json:"file_info,omitempty"`
	// contains filtered or unexported fields
}

func (*SysResourceCounters) Descriptor deprecated

func (*SysResourceCounters) Descriptor() ([]byte, []int)

Deprecated: Use SysResourceCounters.ProtoReflect.Descriptor instead.

func (*SysResourceCounters) GetFileInfo

func (x *SysResourceCounters) GetFileInfo() []*FileInfo

func (*SysResourceCounters) GetProcessInfo

func (x *SysResourceCounters) GetProcessInfo() []*ProcessInfo

func (*SysResourceCounters) GetSystemInfo

func (x *SysResourceCounters) GetSystemInfo() *SystemInfo

func (*SysResourceCounters) ProtoMessage

func (*SysResourceCounters) ProtoMessage()

func (*SysResourceCounters) ProtoReflect

func (x *SysResourceCounters) ProtoReflect() protoreflect.Message

func (*SysResourceCounters) Reset

func (x *SysResourceCounters) Reset()

func (*SysResourceCounters) String

func (x *SysResourceCounters) String() string

type SystemAdminState

type SystemAdminState int

func (SystemAdminState) Int

func (o SystemAdminState) Int() int

func (SystemAdminState) String

func (o SystemAdminState) String() string

type SystemAgent

type SystemAgent struct {
	Id                 ObjectId           `json:"id"`
	Config             SystemAgentConfig  `json:"config"`
	RunningConfig      SystemAgentConfig  `json:"running_config"`
	LastJobStatus      AgentJobStatus     `json:"last_job_status"`
	Status             AgentStatus        `json:"status"`
	TelemetryExtStatus TelemetryExtStatus `json:"telemetry_ext_status"`
	ContainerStatus    ContainerStatus    `json:"container_status"`
	DeviceFacts        DeviceFacts        `json:"device_facts"`
	PlatformConfig     PlatformConfig     `json:"platform_config"`
	PlatformStatus     PlatformStatus     `json:"platform_status"`
}

type SystemAgentConfig

type SystemAgentConfig struct {
	Id                  ObjectId
	Label               string
	Profile             ObjectId
	ForcePackageInstall bool
	InstallRequirements bool
	Packages            AgentPackages
	OpenOptions         map[string]string
	Platform            string
	ManagementIp        string
	AgentTypeOffBox     AgentTypeOffbox
	OperationMode       SystemManagementLevel
	AllowedJobTypes     []AgentJobType
}

type SystemAgentManagerConfig

type SystemAgentManagerConfig struct {
	SkipRevertToPristineOnUninstall bool `json:"skip_revert_to_pristine_on_uninstall"`
	SkipPristineValidation          bool `json:"skip_pristine_validation"`
}

type SystemAgentRequest

type SystemAgentRequest struct {
	AgentTypeOffbox     AgentTypeOffbox
	ManagementIp        string
	OperationMode       SystemManagementLevel
	JobOnCreate         AgentJobType
	Profile             ObjectId
	Username            string
	Password            string
	Packages            AgentPackages
	ForcePackageInstall bool
	InstallRequirements bool
	EnableMonitor       bool
	Label               string
	Platform            AgentPlatform
}

SystemAgentRequest is used when creating/updating system agents

type SystemConfig

type SystemConfig struct {
	SystemId ObjectId
	//DeployState                   string
	//ConfigurationServiceState     string
	LastBootTime                  time.Time
	Deviated                      bool
	ErrorMessage                  *string
	ContiguousFailures            uint32
	UserGoldenConfigUpdateVersion uint32
	UserFullConfigDeployVersion   uint32
	AosConfigVersion              uint32
	ExpectedConfig                string
	ActualConfig                  string
}

func (*SystemConfig) UnmarshalJSON

func (o *SystemConfig) UnmarshalJSON(bytes []byte) error

type SystemContainerStatus

type SystemContainerStatus struct {
	Error  string `json:"error"`
	Host   string `json:"host"`
	Name   string `json:"name"`
	Status string `json:"status"`
}

type SystemFacts

type SystemFacts struct {
	AosHclModel      ObjectId `json:"aos_hcl_model"`
	AosServer        string   `json:"aos_server"`
	AosVersion       string   `json:"aos_version"`
	ChassisMacRanges string   `json:"chassis_mac_ranges"`
	HwModel          string   `json:"hw_model"`
	HwVersion        string   `json:"hw_version"`
	MgmtIfname       string   `json:"mgmt_ifname"`
	MgmtIpaddr       string   `json:"mgmt_ipaddr"`
	MgmtMacaddr      string   `json:"mgmt_macaddr"`
	OsArch           string   `json:"os_arch"`
	OsFamily         string   `json:"os_family"`
	OsVersion        string   `json:"os_version"`
	OsVersionInfo    struct {
		Build string `json:"build"`
		Major string `json:"major"`
		Minor string `json:"minor"`
	} `json:"os_version_info"`
	SerialNumber string `json:"serial_number"`
	Vendor       string `json:"vendor"`
}

type SystemId

type SystemId string

type SystemIdToInterfaceMapAssignment

type SystemIdToInterfaceMapAssignment map[string]interface{}

SystemIdToInterfaceMapAssignment maps graph db 'system' nodes (their id is the string value) to graph db 'interface_map' nodes. interface{} is used for the interface_map nodes because apstra expects 'null' in the JSON fields where no map is assigned.

type SystemInfo

type SystemInfo struct {
	CpuUser     *float32 `protobuf:"fixed32,1,req,name=cpu_user,json=cpuUser" json:"cpu_user,omitempty"`
	CpuSystem   *float32 `protobuf:"fixed32,2,req,name=cpu_system,json=cpuSystem" json:"cpu_system,omitempty"`
	CpuIdle     *float32 `protobuf:"fixed32,3,req,name=cpu_idle,json=cpuIdle" json:"cpu_idle,omitempty"`
	MemoryUsed  *uint64  `protobuf:"varint,4,req,name=memory_used,json=memoryUsed" json:"memory_used,omitempty"`
	MemoryTotal *uint64  `protobuf:"varint,5,req,name=memory_total,json=memoryTotal" json:"memory_total,omitempty"`
	// contains filtered or unexported fields
}

func (*SystemInfo) Descriptor deprecated

func (*SystemInfo) Descriptor() ([]byte, []int)

Deprecated: Use SystemInfo.ProtoReflect.Descriptor instead.

func (*SystemInfo) GetCpuIdle

func (x *SystemInfo) GetCpuIdle() float32

func (*SystemInfo) GetCpuSystem

func (x *SystemInfo) GetCpuSystem() float32

func (*SystemInfo) GetCpuUser

func (x *SystemInfo) GetCpuUser() float32

func (*SystemInfo) GetMemoryTotal

func (x *SystemInfo) GetMemoryTotal() uint64

func (*SystemInfo) GetMemoryUsed

func (x *SystemInfo) GetMemoryUsed() uint64

func (*SystemInfo) ProtoMessage

func (*SystemInfo) ProtoMessage()

func (*SystemInfo) ProtoReflect

func (x *SystemInfo) ProtoReflect() protoreflect.Message

func (*SystemInfo) Reset

func (x *SystemInfo) Reset()

func (*SystemInfo) String

func (x *SystemInfo) String() string

type SystemInterfaceUtilization

type SystemInterfaceUtilization struct {
	AggregateTxBps         *uint32 `protobuf:"varint,1,req,name=aggregate_tx_bps,json=aggregateTxBps" json:"aggregate_tx_bps,omitempty"`
	AggregateRxBps         *uint32 `protobuf:"varint,2,req,name=aggregate_rx_bps,json=aggregateRxBps" json:"aggregate_rx_bps,omitempty"`
	MaxIfcTxUtilization    *uint32 `protobuf:"varint,3,req,name=max_ifc_tx_utilization,json=maxIfcTxUtilization" json:"max_ifc_tx_utilization,omitempty"`
	MaxIfcRxUtilization    *uint32 `protobuf:"varint,4,req,name=max_ifc_rx_utilization,json=maxIfcRxUtilization" json:"max_ifc_rx_utilization,omitempty"`
	AggregateTxUtilization *uint32 `protobuf:"varint,5,req,name=aggregate_tx_utilization,json=aggregateTxUtilization" json:"aggregate_tx_utilization,omitempty"`
	AggregateRxUtilization *uint32 `protobuf:"varint,6,req,name=aggregate_rx_utilization,json=aggregateRxUtilization" json:"aggregate_rx_utilization,omitempty"`
	// contains filtered or unexported fields
}

func (*SystemInterfaceUtilization) Descriptor deprecated

func (*SystemInterfaceUtilization) Descriptor() ([]byte, []int)

Deprecated: Use SystemInterfaceUtilization.ProtoReflect.Descriptor instead.

func (*SystemInterfaceUtilization) GetAggregateRxBps

func (x *SystemInterfaceUtilization) GetAggregateRxBps() uint32

func (*SystemInterfaceUtilization) GetAggregateRxUtilization

func (x *SystemInterfaceUtilization) GetAggregateRxUtilization() uint32

func (*SystemInterfaceUtilization) GetAggregateTxBps

func (x *SystemInterfaceUtilization) GetAggregateTxBps() uint32

func (*SystemInterfaceUtilization) GetAggregateTxUtilization

func (x *SystemInterfaceUtilization) GetAggregateTxUtilization() uint32

func (*SystemInterfaceUtilization) GetMaxIfcRxUtilization

func (x *SystemInterfaceUtilization) GetMaxIfcRxUtilization() uint32

func (*SystemInterfaceUtilization) GetMaxIfcTxUtilization

func (x *SystemInterfaceUtilization) GetMaxIfcTxUtilization() uint32

func (*SystemInterfaceUtilization) ProtoMessage

func (*SystemInterfaceUtilization) ProtoMessage()

func (*SystemInterfaceUtilization) ProtoReflect

func (*SystemInterfaceUtilization) Reset

func (x *SystemInterfaceUtilization) Reset()

func (*SystemInterfaceUtilization) String

func (x *SystemInterfaceUtilization) String() string

type SystemManagementLevel

type SystemManagementLevel int

func (SystemManagementLevel) Int

func (o SystemManagementLevel) Int() int

func (SystemManagementLevel) String

func (o SystemManagementLevel) String() string

type SystemNodeInfo

type SystemNodeInfo struct {
	Asn               *uint32
	DeployMode        *DeployMode
	DeviceProfileId   *ObjectId
	External          bool
	GroupLabel        *string
	Hostname          string
	Id                ObjectId
	InterfaceMapId    *ObjectId
	Label             string
	LogicalDevice     ObjectId
	LoopbackId        *ObjectId
	LoopbackIpv4      *net.IPNet
	LoopbackIpv6      *net.IPNet
	ManagementLevel   SystemManagementLevel
	PodId             ObjectId
	PortChannelIdMax  int
	PortChannelIdMin  int
	RackId            *ObjectId
	RedundancyGroupId *ObjectId
	Role              SystemRole
	Tags              []string
}

type SystemNodeRole

type SystemNodeRole int

func (SystemNodeRole) Int

func (o SystemNodeRole) Int() int

func (SystemNodeRole) QEEAttribute

func (o SystemNodeRole) QEEAttribute() QEEAttribute

func (SystemNodeRole) String

func (o SystemNodeRole) String() string

type SystemRole

type SystemRole int

func (*SystemRole) FromString

func (o *SystemRole) FromString(in string) error

func (SystemRole) String

func (o SystemRole) String() string

type SystemStatus

type SystemStatus struct {
	AgentStartTime  time.Time             `json:"agent_start_time"`
	CommState       string                `json:"comm_state"`
	DeviceStartTime time.Time             `json:"device_start_time"`
	ErrorMessage    string                `json:"error_message"`
	IsAcknowledged  bool                  `json:"is_acknowledged"`
	OperationMode   SystemManagementLevel `json:"operation_mode"`
	State           string                `json:"state"`
}

type SystemType

type SystemType int

func (SystemType) Int

func (o SystemType) Int() int

func (SystemType) String

func (o SystemType) String() string

type SystemUserConfig

type SystemUserConfig struct {
	AdminState  SystemAdminState `json:"admin_state,omitempty"`
	AosHclModel ObjectId         `json:"aos_hcl_model,omitempty"`
	Location    string           `json:"location,omitempty"`
}

type Tag

type Tag struct {
	Name *string `protobuf:"bytes,5,req,name=name" json:"name,omitempty"`
	// Types that are assignable to Value:
	//	*Tag_Int64Value
	//	*Tag_FloatValue
	//	*Tag_StringValue
	Value isTag_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

func (*Tag) Descriptor deprecated

func (*Tag) Descriptor() ([]byte, []int)

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetFloatValue

func (x *Tag) GetFloatValue() float32

func (*Tag) GetInt64Value

func (x *Tag) GetInt64Value() int64

func (*Tag) GetName

func (x *Tag) GetName() string

func (*Tag) GetStringValue

func (x *Tag) GetStringValue() string

func (*Tag) GetValue

func (m *Tag) GetValue() isTag_Value

func (*Tag) ProtoMessage

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect

func (x *Tag) ProtoReflect() protoreflect.Message

func (*Tag) Reset

func (x *Tag) Reset()

func (*Tag) String

func (x *Tag) String() string

type Tag_FloatValue

type Tag_FloatValue struct {
	FloatValue float32 `protobuf:"fixed32,2,opt,name=float_value,json=floatValue,oneof"`
}

type Tag_Int64Value

type Tag_Int64Value struct {
	Int64Value int64 `protobuf:"varint,1,opt,name=int64_value,json=int64Value,oneof"`
}

type Tag_StringValue

type Tag_StringValue struct {
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,oneof"`
}

type TalkToApstraErr

type TalkToApstraErr struct {
	Request  *http.Request
	Response *http.Response
	Msg      string
}

TalkToApstraErr implements error{} and carries around http.Request and http.Response object pointers. Error() method produces a string like "<error> - http response <status> at url <url>".

func (TalkToApstraErr) Error

func (o TalkToApstraErr) Error() string

type TaskId

type TaskId string

TaskId represents outstanding tasks on an Apstra server

type TcpStateQualifier

type TcpStateQualifier oenum.Member[string]

func (*TcpStateQualifier) FromString

func (o *TcpStateQualifier) FromString(s string) error

func (TcpStateQualifier) String

func (o TcpStateQualifier) String() string

type TelemetryExtStatus

type TelemetryExtStatus struct {
	PackagesInstalled AgentPackages `json:"packages_installed"`
	StatusMessage     string        `json:"status_message"`
}

type TelemetryQueryResponse

type TelemetryQueryResponse struct {
	Services []string `json:"services"`
}

type TelemetryServiceMapping

type TelemetryServiceMapping struct {
	ServiceName string   `json:"service_name"`
	Devices     []string `json:"devices"`
}

type Template

type Template interface {
	Type() TemplateType
	ID() ObjectId
	OverlayControlProtocol() OverlayControlProtocol
}

type TemplateCapability

type TemplateCapability int

func (TemplateCapability) Int

func (o TemplateCapability) Int() int

func (TemplateCapability) String

func (o TemplateCapability) String() string

type TemplateElementSpineRequest

type TemplateElementSpineRequest struct {
	Count                  int
	LinkPerSuperspineSpeed LogicalDevicePortSpeed
	LogicalDevice          ObjectId
	LinkPerSuperspineCount int
	Tags                   []ObjectId
}

type TemplateElementSuperspineRequest

type TemplateElementSuperspineRequest struct {
	PlaneCount         int
	Tags               []ObjectId
	SuperspinePerPlane int
	LogicalDeviceId    ObjectId
}

type TemplateFabricAddressingPolicy410Only

type TemplateFabricAddressingPolicy410Only struct {
	SpineSuperspineLinks AddressingScheme
	SpineLeafLinks       AddressingScheme
}

type TemplateL3Collapsed

type TemplateL3Collapsed struct {
	Id ObjectId

	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *TemplateL3CollapsedData
	// contains filtered or unexported fields
}

func (*TemplateL3Collapsed) ID

func (o *TemplateL3Collapsed) ID() ObjectId

func (*TemplateL3Collapsed) OverlayControlProtocol

func (o *TemplateL3Collapsed) OverlayControlProtocol() OverlayControlProtocol

func (*TemplateL3Collapsed) Type

type TemplateL3CollapsedData

type TemplateL3CollapsedData struct {
	DisplayName          string
	AntiAffinityPolicy   *AntiAffinityPolicy
	RackTypes            []RackType
	Capability           TemplateCapability
	MeshLinkSpeed        LogicalDevicePortSpeed
	VirtualNetworkPolicy VirtualNetworkPolicy
	MeshLinkCount        int
	RackTypeCounts       []RackTypeCount
	DhcpServiceIntent    DhcpServiceIntent
}

type TemplatePodBased

type TemplatePodBased struct {
	Id ObjectId

	CreatedAt      time.Time
	LastModifiedAt time.Time
	Data           *TemplatePodBasedData
	// contains filtered or unexported fields
}

func (*TemplatePodBased) ID

func (o *TemplatePodBased) ID() ObjectId

func (*TemplatePodBased) OverlayControlProtocol

func (o *TemplatePodBased) OverlayControlProtocol() OverlayControlProtocol

func (*TemplatePodBased) Type

func (o *TemplatePodBased) Type() TemplateType

type TemplatePodBasedData

type TemplatePodBasedData struct {
	DisplayName            string
	AntiAffinityPolicy     *AntiAffinityPolicy
	FabricAddressingPolicy *TemplateFabricAddressingPolicy410Only // Apstra 4.1.0 only
	Superspine             Superspine
	Capability             TemplateCapability
	PodInfo                map[ObjectId]TemplatePodBasedInfo
}

type TemplatePodBasedInfo

type TemplatePodBasedInfo struct {
	Count                 int
	TemplateRackBasedData *TemplateRackBasedData
}

type TemplateRackBased

type TemplateRackBased struct {
	Id             ObjectId
	CreatedAt      time.Time
	LastModifiedAt time.Time

	Data *TemplateRackBasedData
	// contains filtered or unexported fields
}

func (*TemplateRackBased) ID

func (o *TemplateRackBased) ID() ObjectId

func (*TemplateRackBased) OverlayControlProtocol

func (o *TemplateRackBased) OverlayControlProtocol() OverlayControlProtocol

func (*TemplateRackBased) Type

func (o *TemplateRackBased) Type() TemplateType

type TemplateRackBasedData

type TemplateRackBasedData struct {
	DisplayName            string
	AntiAffinityPolicy     *AntiAffinityPolicy
	VirtualNetworkPolicy   VirtualNetworkPolicy
	AsnAllocationPolicy    AsnAllocationPolicy
	FabricAddressingPolicy *TemplateFabricAddressingPolicy410Only // Apstra 4.1.0 only
	Capability             TemplateCapability
	Spine                  Spine
	RackInfo               map[ObjectId]TemplateRackBasedRackInfo
	DhcpServiceIntent      DhcpServiceIntent
}

type TemplateRackBasedRackInfo

type TemplateRackBasedRackInfo struct {
	Count        int
	RackTypeData *RackTypeData
}

type TemplateType

type TemplateType int

func AllTemplateTypes

func AllTemplateTypes() []TemplateType

AllTemplateTypes returns the []TemplateType representing each supported TemplateType

func (*TemplateType) FromString

func (o *TemplateType) FromString(s string) error

func (TemplateType) Int

func (o TemplateType) Int() int

func (TemplateType) String

func (o TemplateType) String() string

type TestAlert

type TestAlert struct {
	TestInt *uint64 `protobuf:"varint,1,req,name=test_int,json=testInt" json:"test_int,omitempty"`
	// contains filtered or unexported fields
}

func (*TestAlert) Descriptor deprecated

func (*TestAlert) Descriptor() ([]byte, []int)

Deprecated: Use TestAlert.ProtoReflect.Descriptor instead.

func (*TestAlert) GetTestInt

func (x *TestAlert) GetTestInt() uint64

func (*TestAlert) ProtoMessage

func (*TestAlert) ProtoMessage()

func (*TestAlert) ProtoReflect

func (x *TestAlert) ProtoReflect() protoreflect.Message

func (*TestAlert) Reset

func (x *TestAlert) Reset()

func (*TestAlert) String

func (x *TestAlert) String() string

type TrafficEvent

type TrafficEvent struct {

	// Types that are assignable to Source:
	//	*TrafficEvent_NodeRole
	//	*TrafficEvent_PortRole
	//	*TrafficEvent_Port
	//	*TrafficEvent_Node
	//	*TrafficEvent_Pod
	Source          isTrafficEvent_Source `protobuf_oneof:"source"`
	IntervalSeconds *uint32               `protobuf:"varint,6,req,name=interval_seconds,json=intervalSeconds" json:"interval_seconds,omitempty"`
	MeasurementName *string               `protobuf:"bytes,7,req,name=measurement_name,json=measurementName" json:"measurement_name,omitempty"`
	AggregationType *AggregationType      `` /* 135-byte string literal not displayed */
	// Types that are assignable to Delta:
	//	*TrafficEvent_DeltaPercentage
	//	*TrafficEvent_DeltaNonnormalized
	Delta isTrafficEvent_Delta `protobuf_oneof:"delta"`
	// contains filtered or unexported fields
}

func (*TrafficEvent) Descriptor deprecated

func (*TrafficEvent) Descriptor() ([]byte, []int)

Deprecated: Use TrafficEvent.ProtoReflect.Descriptor instead.

func (*TrafficEvent) GetAggregationType

func (x *TrafficEvent) GetAggregationType() AggregationType

func (*TrafficEvent) GetDelta

func (m *TrafficEvent) GetDelta() isTrafficEvent_Delta

func (*TrafficEvent) GetDeltaNonnormalized

func (x *TrafficEvent) GetDeltaNonnormalized() int64

func (*TrafficEvent) GetDeltaPercentage

func (x *TrafficEvent) GetDeltaPercentage() int32

func (*TrafficEvent) GetIntervalSeconds

func (x *TrafficEvent) GetIntervalSeconds() uint32

func (*TrafficEvent) GetMeasurementName

func (x *TrafficEvent) GetMeasurementName() string

func (*TrafficEvent) GetNode

func (x *TrafficEvent) GetNode() string

func (*TrafficEvent) GetNodeRole

func (x *TrafficEvent) GetNodeRole() Feature

func (*TrafficEvent) GetPod

func (x *TrafficEvent) GetPod() bool

func (*TrafficEvent) GetPort

func (x *TrafficEvent) GetPort() string

func (*TrafficEvent) GetPortRole

func (x *TrafficEvent) GetPortRole() Feature

func (*TrafficEvent) GetSource

func (m *TrafficEvent) GetSource() isTrafficEvent_Source

func (*TrafficEvent) ProtoMessage

func (*TrafficEvent) ProtoMessage()

func (*TrafficEvent) ProtoReflect

func (x *TrafficEvent) ProtoReflect() protoreflect.Message

func (*TrafficEvent) Reset

func (x *TrafficEvent) Reset()

func (*TrafficEvent) String

func (x *TrafficEvent) String() string

type TrafficEvent_DeltaNonnormalized

type TrafficEvent_DeltaNonnormalized struct {
	DeltaNonnormalized int64 `protobuf:"varint,10,opt,name=delta_nonnormalized,json=deltaNonnormalized,oneof"`
}

type TrafficEvent_DeltaPercentage

type TrafficEvent_DeltaPercentage struct {
	DeltaPercentage int32 `protobuf:"varint,9,opt,name=delta_percentage,json=deltaPercentage,oneof"`
}

type TrafficEvent_Node

type TrafficEvent_Node struct {
	Node string `protobuf:"bytes,4,opt,name=node,oneof"`
}

type TrafficEvent_NodeRole

type TrafficEvent_NodeRole struct {
	NodeRole Feature `protobuf:"varint,1,opt,name=node_role,json=nodeRole,enum=aos.streaming.Feature,oneof"`
}

type TrafficEvent_Pod

type TrafficEvent_Pod struct {
	Pod bool `protobuf:"varint,5,opt,name=pod,oneof"`
}

type TrafficEvent_Port

type TrafficEvent_Port struct {
	Port string `protobuf:"bytes,3,opt,name=port,oneof"`
}

type TrafficEvent_PortRole

type TrafficEvent_PortRole struct {
	PortRole Feature `protobuf:"varint,2,opt,name=port_role,json=portRole,enum=aos.streaming.Feature,oneof"`
}

type TransformInterface

type TransformInterface struct {
	State       string
	Setting     string
	Speed       LogicalDevicePortSpeed
	Name        string
	InterfaceId int
}

type Transformation

type Transformation struct {
	IsDefault        bool
	Interfaces       []TransformInterface
	TransformationId int
}

func (*Transformation) Interface

func (o *Transformation) Interface(desired int) (*TransformInterface, error)

func (*Transformation) InterfaceIds

func (o *Transformation) InterfaceIds() []int

type TwoStageL3ClosClient

type TwoStageL3ClosClient struct {
	Mutex Mutex
	// contains filtered or unexported fields
}

func (*TwoStageL3ClosClient) AddLinksToSystem

func (o *TwoStageL3ClosClient) AddLinksToSystem(ctx context.Context, linkRequests []CreateLinkRequest) ([]ObjectId, error)

func (*TwoStageL3ClosClient) AddPolicyRule

func (o *TwoStageL3ClosClient) AddPolicyRule(ctx context.Context, rule *PolicyRuleData, position int, policyId ObjectId) (ObjectId, error)

AddPolicyRule adds a policy rule at 'position' (bumping all other rules down). Position 0 makes the new policy first on the list, 1 makes it second on the list, etc... Use -1 for last on the list. The returned ObjectId represents the new rule

func (*TwoStageL3ClosClient) Client

func (o *TwoStageL3ClosClient) Client() *Client

Client returns the embedded *Client

func (*TwoStageL3ClosClient) CreateConfiglet

CreateConfiglet creates a configlet described by a TwoStageL3ClosConfigletData structure in a blueprint.

func (*TwoStageL3ClosClient) CreateConnectivityTemplate

func (o *TwoStageL3ClosClient) CreateConnectivityTemplate(ctx context.Context, in *ConnectivityTemplate) error

func (*TwoStageL3ClosClient) CreateIbaDashboard

func (o *TwoStageL3ClosClient) CreateIbaDashboard(ctx context.Context, data *IbaDashboardData) (ObjectId, error)

CreateIbaDashboard creates an IBA Dashboard and returns the id of the created dashboard on success, or a blank and error on failure

func (*TwoStageL3ClosClient) CreateIbaProbeFromJson

func (o *TwoStageL3ClosClient) CreateIbaProbeFromJson(ctx context.Context, probeJson json.RawMessage) (ObjectId, error)

CreateIbaProbeFromJson creates an IBA Probe

func (*TwoStageL3ClosClient) CreateIbaWidget

func (o *TwoStageL3ClosClient) CreateIbaWidget(ctx context.Context, data *IbaWidgetData) (ObjectId, error)

CreateIbaWidget creates an IBA Widget and returns the id of the created dashboard on success, or a blank and error on failure

func (*TwoStageL3ClosClient) CreateLinksWithNewSystem

func (o *TwoStageL3ClosClient) CreateLinksWithNewSystem(ctx context.Context, req *CreateLinksWithNewSystemRequest) ([]ObjectId, error)

func (*TwoStageL3ClosClient) CreatePolicy

func (o *TwoStageL3ClosClient) CreatePolicy(ctx context.Context, data *PolicyData) (ObjectId, error)

CreatePolicy creates a policy within the DC blueprint, returns its ID

func (*TwoStageL3ClosClient) CreateRack

func (*TwoStageL3ClosClient) CreateRemoteGateway

func (o *TwoStageL3ClosClient) CreateRemoteGateway(ctx context.Context, in *RemoteGatewayData) (ObjectId, error)

CreateRemoteGateway creates an EVPN remote / external gateway using the specified parameters

func (*TwoStageL3ClosClient) CreateRoutingPolicy

func (o *TwoStageL3ClosClient) CreateRoutingPolicy(ctx context.Context, in *DcRoutingPolicyData) (ObjectId, error)

CreateRoutingPolicy creates a blueprint routing policy according to the supplied *DcRoutingPolicyData.

func (*TwoStageL3ClosClient) CreateSecurityZone

func (o *TwoStageL3ClosClient) CreateSecurityZone(ctx context.Context, cfg *SecurityZoneData) (ObjectId, error)

CreateSecurityZone creates an Apstra Routing Zone / Security Zone / VRF. If cfg.JunosEvpnIrbMode is omitted, but the API's version-dependent behavior requires that field, it will be set to JunosEvpnIrbModeAsymmetric in the request sent to the API.

func (*TwoStageL3ClosClient) CreateVirtualNetwork

func (o *TwoStageL3ClosClient) CreateVirtualNetwork(ctx context.Context, in *VirtualNetworkData) (ObjectId, error)

CreateVirtualNetwork creates a new virtual network according to the supplied VirtualNetworkData

func (*TwoStageL3ClosClient) DelApplicationPointConnectivityTemplates

func (o *TwoStageL3ClosClient) DelApplicationPointConnectivityTemplates(ctx context.Context, apId ObjectId, ctIds []ObjectId) error

DelApplicationPointConnectivityTemplates removes the listed ConnectivityTemplate IDs from the application point specified by apId

func (*TwoStageL3ClosClient) DeleteConfiglet

func (o *TwoStageL3ClosClient) DeleteConfiglet(ctx context.Context, id ObjectId) error

DeleteConfiglet deletes a configlet from the blueprint given the id

func (*TwoStageL3ClosClient) DeleteConnectivityTemplate

func (o *TwoStageL3ClosClient) DeleteConnectivityTemplate(ctx context.Context, id ObjectId) error

func (*TwoStageL3ClosClient) DeleteGenericSystem

func (o *TwoStageL3ClosClient) DeleteGenericSystem(ctx context.Context, id ObjectId) error

func (*TwoStageL3ClosClient) DeleteIbaDashboard

func (o *TwoStageL3ClosClient) DeleteIbaDashboard(ctx context.Context, id ObjectId) error

DeleteIbaDashboard deletes an IBA Dashboard and returns an error on failure

func (*TwoStageL3ClosClient) DeleteIbaProbe

func (o *TwoStageL3ClosClient) DeleteIbaProbe(ctx context.Context, id ObjectId) error

DeleteIbaProbe deletes an IBA Probe

func (*TwoStageL3ClosClient) DeleteIbaWidget

func (o *TwoStageL3ClosClient) DeleteIbaWidget(ctx context.Context, id ObjectId) error

DeleteIbaWidget deletes an IBA Widget

func (*TwoStageL3ClosClient) DeleteLinksFromSystem

func (o *TwoStageL3ClosClient) DeleteLinksFromSystem(ctx context.Context, ids []ObjectId) error

func (*TwoStageL3ClosClient) DeletePolicy

func (o *TwoStageL3ClosClient) DeletePolicy(ctx context.Context, id ObjectId) error

DeletePolicy deletes policy 'id' within the DC blueprint

func (*TwoStageL3ClosClient) DeletePolicyRuleById

func (o *TwoStageL3ClosClient) DeletePolicyRuleById(ctx context.Context, policyId ObjectId, ruleId ObjectId) error

DeletePolicyRuleById deletes the given rule. If the rule doesn't exist, a ClientErr with ErrNotFound is returned.

func (*TwoStageL3ClosClient) DeletePropertySet

func (o *TwoStageL3ClosClient) DeletePropertySet(ctx context.Context, id ObjectId) error

DeletePropertySet deletes a property set given the id

func (*TwoStageL3ClosClient) DeleteRack

func (o *TwoStageL3ClosClient) DeleteRack(ctx context.Context, id ObjectId) error

func (*TwoStageL3ClosClient) DeleteRemoteGateway

func (o *TwoStageL3ClosClient) DeleteRemoteGateway(ctx context.Context, id ObjectId) error

DeleteRemoteGateway deletes the specified remote / external gateway

func (*TwoStageL3ClosClient) DeleteRoutingPolicy

func (o *TwoStageL3ClosClient) DeleteRoutingPolicy(ctx context.Context, id ObjectId) error

DeleteRoutingPolicy deletes the routing policy specified by id.

func (*TwoStageL3ClosClient) DeleteSecurityZone

func (o *TwoStageL3ClosClient) DeleteSecurityZone(ctx context.Context, zoneId ObjectId) error

DeleteSecurityZone deletes an Apstra Routing Zone / Security Zone / VRF

func (*TwoStageL3ClosClient) DeleteVirtualNetwork

func (o *TwoStageL3ClosClient) DeleteVirtualNetwork(ctx context.Context, id ObjectId) error

DeleteVirtualNetwork deletes the virtual network specified by id from the blueprint.

func (*TwoStageL3ClosClient) GetAllApplicationPointsConnectivityTemplates

func (o *TwoStageL3ClosClient) GetAllApplicationPointsConnectivityTemplates(ctx context.Context) (map[ObjectId]map[ObjectId]bool, error)

GetAllApplicationPointsConnectivityTemplates returns map[ObjectId]map[ObjectId]bool The outer map is ApplicationPointId => CT state map The inner map is ConnectivityTemplateId => State (bool) where

true: the CT is used on this Application Point
false: the CT is not used on this Application Point, but it is valid here

func (*TwoStageL3ClosClient) GetAllConfigletIds

func (o *TwoStageL3ClosClient) GetAllConfigletIds(ctx context.Context) ([]ObjectId, error)

GetAllConfigletIds returns Ids of all the configlets imported into a blueprint

func (*TwoStageL3ClosClient) GetAllConfiglets

func (o *TwoStageL3ClosClient) GetAllConfiglets(ctx context.Context) ([]TwoStageL3ClosConfiglet, error)

GetAllConfiglets returns []TwoStageL3ClosConfiglet representing all configlets imported into a blueprint

func (*TwoStageL3ClosClient) GetAllConnectivityTemplateStates

func (o *TwoStageL3ClosClient) GetAllConnectivityTemplateStates(ctx context.Context) ([]ConnectivityTemplateState, error)

func (*TwoStageL3ClosClient) GetAllConnectivityTemplates

func (o *TwoStageL3ClosClient) GetAllConnectivityTemplates(ctx context.Context) ([]ConnectivityTemplate, error)

func (*TwoStageL3ClosClient) GetAllIbaDashboards

func (o *TwoStageL3ClosClient) GetAllIbaDashboards(ctx context.Context) ([]IbaDashboard, error)

GetAllIbaDashboards returns a list of IBA Dashboards in the blueprint

func (*TwoStageL3ClosClient) GetAllIbaPredefinedProbes

func (o *TwoStageL3ClosClient) GetAllIbaPredefinedProbes(ctx context.Context) ([]IbaPredefinedProbe, error)

GetAllIbaPredefinedProbes lists all the Predefined IBA probes available to a blueprint

func (*TwoStageL3ClosClient) GetAllIbaWidgets

func (o *TwoStageL3ClosClient) GetAllIbaWidgets(ctx context.Context) ([]IbaWidget, error)

GetAllIbaWidgets returns a list of IBA Widgets in the blueprint

func (*TwoStageL3ClosClient) GetAllInterfacesConnectivityTemplates

func (o *TwoStageL3ClosClient) GetAllInterfacesConnectivityTemplates(ctx context.Context) (map[ObjectId][]ObjectId, error)

GetAllInterfacesConnectivityTemplates returns a map of ConnectivityTemplate IDs keyed by Interface (switch port) ID.

func (*TwoStageL3ClosClient) GetAllPolicies

func (o *TwoStageL3ClosClient) GetAllPolicies(ctx context.Context) ([]Policy, error)

GetAllPolicies returns []Policy representing all policies configured within the DC blueprint

func (*TwoStageL3ClosClient) GetAllPropertySets

func (o *TwoStageL3ClosClient) GetAllPropertySets(ctx context.Context) ([]TwoStageL3ClosPropertySet, error)

GetAllPropertySets returns []TwoStageL3ClosPropertySet representing all property sets imported into a blueprint

func (*TwoStageL3ClosClient) GetAllRemoteGateways

func (o *TwoStageL3ClosClient) GetAllRemoteGateways(ctx context.Context) ([]RemoteGateway, error)

GetAllRemoteGateways retrieves all remote / external gateways

func (*TwoStageL3ClosClient) GetAllRoutingPolicies

func (o *TwoStageL3ClosClient) GetAllRoutingPolicies(ctx context.Context) ([]DcRoutingPolicy, error)

GetAllRoutingPolicies returns []DcRoutingPolicy representing all routing policies in the blueprint.

func (*TwoStageL3ClosClient) GetAllSecurityZones

func (o *TwoStageL3ClosClient) GetAllSecurityZones(ctx context.Context) ([]SecurityZone, error)

GetAllSecurityZones returns []SecurityZone representing all Security Zones / Routing Zones / VRFs on the system.

func (*TwoStageL3ClosClient) GetAllSystemNodeInfos

func (o *TwoStageL3ClosClient) GetAllSystemNodeInfos(ctx context.Context) (map[ObjectId]SystemNodeInfo, error)

GetAllSystemNodeInfos return map[ObjectId]SystemNodeInfo describing all "system" nodes in the blueprint.

func (*TwoStageL3ClosClient) GetAllVirtualNetworks

func (o *TwoStageL3ClosClient) GetAllVirtualNetworks(ctx context.Context) (map[ObjectId]VirtualNetwork, error)

GetAllVirtualNetworks return map[ObjectId]VirtualNetwork representing all virtual networks configured in Apstra. NOTE: the underlying API call DOES NOT RETURN the SVI information, so each map entry will have a nil slice at it's Data.SviIps struct element.

func (*TwoStageL3ClosClient) GetApplicationPointConnectivityTemplates

func (o *TwoStageL3ClosClient) GetApplicationPointConnectivityTemplates(ctx context.Context, apId ObjectId) (map[ObjectId]bool, error)

GetApplicationPointConnectivityTemplates returns map[ObjectId]bool based on the supplied apId (ObjectId representing an Application Point ID). The map is ConnectivityTemplateId => State (bool) where

true: the CT is used on this Application Point
false: the CT is not used on this Application Point, but it is valid here

func (*TwoStageL3ClosClient) GetApplicationPointsConnectivityTemplatesByCt

func (o *TwoStageL3ClosClient) GetApplicationPointsConnectivityTemplatesByCt(ctx context.Context, ctId ObjectId) (map[ObjectId]map[ObjectId]bool, error)

GetApplicationPointsConnectivityTemplatesByCt returns map[ObjectId]map[ObjectId]bool based on the supplied ctId (ObjectId representing a Connectivity Template ID). The outer map is ApplicationPointId => CT state map The inner map is ConnectivityTemplateId => State (bool) where

true: the CT is used on this Application Point
false: the CT is not used on this Application Point, but it is valid here

Each inner map will only have a single key (the supplied ctId), but nested maps are used here for consistency with similar calls.

func (o *TwoStageL3ClosClient) GetCablingMapLinks(ctx context.Context) ([]CablingMapLink, error)

GetCablingMapLinks returns []CablingMapLink representing every link in the blueprint

func (*TwoStageL3ClosClient) GetCablingMapLinksBySystem

func (o *TwoStageL3ClosClient) GetCablingMapLinksBySystem(ctx context.Context, systemNodeId ObjectId) ([]CablingMapLink, error)

GetCablingMapLinksBySystem returns []CablingMapLink representing every link (including LAGs)

func (*TwoStageL3ClosClient) GetConfiglet

GetConfiglet returns *TwoStageL3ClosConfiglet representing the imported configlet with the given ID in the specified blueprint

func (*TwoStageL3ClosClient) GetConfigletByName

func (o *TwoStageL3ClosClient) GetConfigletByName(ctx context.Context, in string) (*TwoStageL3ClosConfiglet, error)

GetConfigletByName returns *TwoStageL3ClosConfiglet representing the only configlet with the given label, or an error if no configlet by that name exists

func (*TwoStageL3ClosClient) GetConnectivityTemplate

func (o *TwoStageL3ClosClient) GetConnectivityTemplate(ctx context.Context, id ObjectId) (*ConnectivityTemplate, error)

func (*TwoStageL3ClosClient) GetConnectivityTemplateState

func (o *TwoStageL3ClosClient) GetConnectivityTemplateState(ctx context.Context, id ObjectId) (*ConnectivityTemplateState, error)

func (*TwoStageL3ClosClient) GetConnectivityTemplatesByApplicationPoints

func (o *TwoStageL3ClosClient) GetConnectivityTemplatesByApplicationPoints(ctx context.Context, apIds []ObjectId) (map[ObjectId]map[ObjectId]bool, error)

GetConnectivityTemplatesByApplicationPoints returns map[ObjectId]map[ObjectId]bool based on the supplied apIds ([]ObjectId representing Application Point IDs). The outer map is ApplicationPointId => CT state map The inner map is ConnectivityTemplateId => State (bool) where

true: the CT is used on this Application Point
false: the CT is not used on this Application Point, but it is valid here

func (*TwoStageL3ClosClient) GetDefaultRoutingPolicy

func (o *TwoStageL3ClosClient) GetDefaultRoutingPolicy(ctx context.Context) (*DcRoutingPolicy, error)

GetDefaultRoutingPolicy returns *DcRoutingPolicy representing the "default_immutable" routing policy attached to the blueprint.

func (*TwoStageL3ClosClient) GetFabricAddressingPolicy

func (o *TwoStageL3ClosClient) GetFabricAddressingPolicy(ctx context.Context) (*TwoStageL3ClosFabricAddressingPolicy, error)

func (*TwoStageL3ClosClient) GetFabricSettings

func (o *TwoStageL3ClosClient) GetFabricSettings(ctx context.Context) (*FabricSettings, error)

GetFabricSettings gets the fabric settings

func (*TwoStageL3ClosClient) GetGenericSystemLoopback

func (o *TwoStageL3ClosClient) GetGenericSystemLoopback(ctx context.Context, nodeId ObjectId, loopbackId int) (*GenericSystemLoopback, error)

func (*TwoStageL3ClosClient) GetGenericSystemLoopbacks

func (o *TwoStageL3ClosClient) GetGenericSystemLoopbacks(ctx context.Context, nodeId ObjectId) (map[int]GenericSystemLoopback, error)

func (*TwoStageL3ClosClient) GetIbaDashboard

func (o *TwoStageL3ClosClient) GetIbaDashboard(ctx context.Context, id ObjectId) (*IbaDashboard, error)

GetIbaDashboard returns the IBA Dashboard that matches the ID

func (*TwoStageL3ClosClient) GetIbaDashboardByLabel

func (o *TwoStageL3ClosClient) GetIbaDashboardByLabel(ctx context.Context, label string) (*IbaDashboard, error)

GetIbaDashboardByLabel returns the IBA Dashboard that matches the label. It will return an error if more than one IBA dashboard matches the label.

func (*TwoStageL3ClosClient) GetIbaPredefinedProbeByName

func (o *TwoStageL3ClosClient) GetIbaPredefinedProbeByName(ctx context.Context, name string) (*IbaPredefinedProbe, error)

GetIbaPredefinedProbeByName locates a predefined probe by name

func (*TwoStageL3ClosClient) GetIbaProbe

func (o *TwoStageL3ClosClient) GetIbaProbe(ctx context.Context, id ObjectId) (*IbaProbe, error)

GetIbaProbe returns the IBA Probe that matches the ID

func (*TwoStageL3ClosClient) GetIbaProbeState

func (o *TwoStageL3ClosClient) GetIbaProbeState(ctx context.Context, id ObjectId) (*IbaProbeState, error)

GetIbaProbeState returns the State of the IBA Probe that matches the ID

func (*TwoStageL3ClosClient) GetIbaWidget

func (o *TwoStageL3ClosClient) GetIbaWidget(ctx context.Context, id ObjectId) (*IbaWidget, error)

GetIbaWidget returns the IBA Widget that matches the ID

func (*TwoStageL3ClosClient) GetIbaWidgetByLabel

func (o *TwoStageL3ClosClient) GetIbaWidgetByLabel(ctx context.Context, label string) (*IbaWidget, error)

GetIbaWidgetByLabel returns the IBA Widgets in the blueprint which matches the specified label, or an error in the case of no matches, or multiple matches

func (*TwoStageL3ClosClient) GetIbaWidgetsByLabel

func (o *TwoStageL3ClosClient) GetIbaWidgetsByLabel(ctx context.Context, label string) ([]IbaWidget, error)

GetIbaWidgetsByLabel returns a list of IBA Widgets in the blueprint that match the label

func (*TwoStageL3ClosClient) GetInterfaceConnectivityTemplates

func (o *TwoStageL3ClosClient) GetInterfaceConnectivityTemplates(ctx context.Context, intfId ObjectId) ([]ObjectId, error)

func (*TwoStageL3ClosClient) GetInterfaceMapAssignments

func (o *TwoStageL3ClosClient) GetInterfaceMapAssignments(ctx context.Context) (SystemIdToInterfaceMapAssignment, error)

GetInterfaceMapAssignments returns a SystemIdToInterfaceMapAssignment (a map of string (blueprint graph node ID) to interface map ID detailing assignments in the specified blueprint:

x := SystemIdToInterfaceMapAssignment{
	"BeAyAoCIgqx4r3hiFow": nil,
	"B3Ym-PBJJEtvXQsnQQM": "VS_SONiC_BUZZNIK_PLUS__slicer-7x10-1",
	"4gCWV2NRix6MYPm4PHU": "Arista_vEOS__slicer-7x10-1",
}

func (*TwoStageL3ClosClient) GetLockInfo

func (o *TwoStageL3ClosClient) GetLockInfo(ctx context.Context) (*LockInfo, error)

GetLockInfo returns *LockInfo describing the current state of the blueprint lock

func (*TwoStageL3ClosClient) GetNodeTags

func (o *TwoStageL3ClosClient) GetNodeTags(ctx context.Context, nodeId ObjectId) ([]string, error)

func (*TwoStageL3ClosClient) GetNodes

func (o *TwoStageL3ClosClient) GetNodes(ctx context.Context, nodeType NodeType, response interface{}) error

GetNodes fetches the node of the specified type, unpacks the API response into 'response'

func (*TwoStageL3ClosClient) GetPolicy

func (o *TwoStageL3ClosClient) GetPolicy(ctx context.Context, id ObjectId) (*Policy, error)

GetPolicy returns *Policy representing policy 'id' within the DC blueprint

func (*TwoStageL3ClosClient) GetPolicyByLabel

func (o *TwoStageL3ClosClient) GetPolicyByLabel(ctx context.Context, label string) (*Policy, error)

GetPolicyByLabel returns *Policy representing policy identified by 'label' within the DC blueprint

func (*TwoStageL3ClosClient) GetPropertySet

GetPropertySet returns *TwoStageL3ClosPropertySet representing the imported property set with the given ID in the specified blueprint

func (*TwoStageL3ClosClient) GetPropertySetByName

func (o *TwoStageL3ClosClient) GetPropertySetByName(ctx context.Context, in string) (*TwoStageL3ClosPropertySet, error)

GetPropertySetByName returns *TwoStageL3ClosPropertySet representing the only property set with the given label, or an error if multiple property sets share the label.

func (*TwoStageL3ClosClient) GetRemoteGateway

func (o *TwoStageL3ClosClient) GetRemoteGateway(ctx context.Context, id ObjectId) (*RemoteGateway, error)

GetRemoteGateway retrieves the remote / external gateway specified by id

func (*TwoStageL3ClosClient) GetRemoteGatewayByName

func (o *TwoStageL3ClosClient) GetRemoteGatewayByName(ctx context.Context, name string) (*RemoteGateway, error)

GetRemoteGatewayByName retrieves the remote / external gateway specified by name

func (*TwoStageL3ClosClient) GetResourceAllocation

func (o *TwoStageL3ClosClient) GetResourceAllocation(ctx context.Context, in *ResourceGroup) (*ResourceGroupAllocation, error)

GetResourceAllocation takes a *ResourceGroup and returns a *ResourceGroupAllocation with fields populated based on the Apstra API response.

func (*TwoStageL3ClosClient) GetResourceAllocations

func (o *TwoStageL3ClosClient) GetResourceAllocations(ctx context.Context) (ResourceGroupAllocations, error)

GetResourceAllocations returns ResourceGroupAllocations representing all allocations of resource pools to blueprint requirements

func (*TwoStageL3ClosClient) GetRoutingPolicy

func (o *TwoStageL3ClosClient) GetRoutingPolicy(ctx context.Context, id ObjectId) (*DcRoutingPolicy, error)

GetRoutingPolicy returns *DcRoutingPolicy representing the specified policy.

func (*TwoStageL3ClosClient) GetRoutingPolicyByName

func (o *TwoStageL3ClosClient) GetRoutingPolicyByName(ctx context.Context, desired string) (*DcRoutingPolicy, error)

func (*TwoStageL3ClosClient) GetSecurityZone

func (o *TwoStageL3ClosClient) GetSecurityZone(ctx context.Context, zoneId ObjectId) (*SecurityZone, error)

GetSecurityZone fetches the Security Zone / Routing Zone / VRF with the given zoneId.

func (*TwoStageL3ClosClient) GetSecurityZoneByVrfName

func (o *TwoStageL3ClosClient) GetSecurityZoneByVrfName(ctx context.Context, vrfName string) (*SecurityZone, error)

GetSecurityZoneByVrfName fetches the Security Zone / Routing Zone / VRF with the given label.

func (*TwoStageL3ClosClient) GetSecurityZoneDhcpServers

func (o *TwoStageL3ClosClient) GetSecurityZoneDhcpServers(ctx context.Context, zoneId ObjectId) ([]net.IP, error)

GetSecurityZoneDhcpServers returns []net.IP representing the DHCP relay targets for the security zone specified by zoneId.

func (*TwoStageL3ClosClient) GetSystemNodeInfo

func (o *TwoStageL3ClosClient) GetSystemNodeInfo(ctx context.Context, nodeId ObjectId) (*SystemNodeInfo, error)

GetSystemNodeInfo returns a SystemNodeInfo describing a "system" node.

func (*TwoStageL3ClosClient) GetTransformationId

func (o *TwoStageL3ClosClient) GetTransformationId(ctx context.Context, interfaceNodeId ObjectId) (int, error)

GetTransformationId returns the current transform number of the specified interface node

func (*TwoStageL3ClosClient) GetTransformationIdByIfName

func (o *TwoStageL3ClosClient) GetTransformationIdByIfName(ctx context.Context, systemNodeId ObjectId, ifName string) (int, error)

GetTransformationIdByIfName returns the current transform number of the named interface on the specified system node

func (*TwoStageL3ClosClient) GetVirtualNetwork

func (o *TwoStageL3ClosClient) GetVirtualNetwork(ctx context.Context, vnId ObjectId) (*VirtualNetwork, error)

GetVirtualNetwork returns *VirtualNetwork representing the given vnId

func (*TwoStageL3ClosClient) GetVirtualNetworkByName

func (o *TwoStageL3ClosClient) GetVirtualNetworkByName(ctx context.Context, name string) (*VirtualNetwork, error)

GetVirtualNetworkByName returns *VirtualNetwork representing the given VN name

func (*TwoStageL3ClosClient) Id

Id returns the client's Blueprint ID

func (*TwoStageL3ClosClient) ImportConfigletById

func (o *TwoStageL3ClosClient) ImportConfigletById(ctx context.Context, cid ObjectId, condition string, label string) (ObjectId, error)

ImportConfigletById imports a configlet from the catalog into a blueprint. cid is the Id catalog configlet of the condtion is a string input that indicates which devices it applies to. label can be used to rename the configlet in the blue print On success, it returns the id of the imported configlet.

func (*TwoStageL3ClosClient) ImportPropertySet

func (o *TwoStageL3ClosClient) ImportPropertySet(ctx context.Context, psid ObjectId, keys ...string) (ObjectId, error)

ImportPropertySet imports a property set into a blueprint. On success, it returns the id of the imported property set. Optionally, a set of keys can be part of the request

func (*TwoStageL3ClosClient) InstantiateIbaPredefinedProbe

func (o *TwoStageL3ClosClient) InstantiateIbaPredefinedProbe(ctx context.Context, data *IbaPredefinedProbeRequest) (ObjectId, error)

InstantiateIbaPredefinedProbe instantiates a predefined probe using the name and properties specified in data and returns the id of the created probe on success, or a blank and error on failure.

func (*TwoStageL3ClosClient) ListAllVirtualNetworkIds

func (o *TwoStageL3ClosClient) ListAllVirtualNetworkIds(ctx context.Context) ([]ObjectId, error)

ListAllVirtualNetworkIds returns []ObjectId representing virtual networks configured in the blueprint

func (*TwoStageL3ClosClient) ListConnectivityTemplates

func (o *TwoStageL3ClosClient) ListConnectivityTemplates(ctx context.Context) ([]ObjectId, error)

func (*TwoStageL3ClosClient) NodeIdsByType

func (o *TwoStageL3ClosClient) NodeIdsByType(ctx context.Context, nt NodeType) ([]ObjectId, error)

func (*TwoStageL3ClosClient) PatchNode

func (o *TwoStageL3ClosClient) PatchNode(ctx context.Context, node ObjectId, request interface{}, response interface{}) error

PatchNode patches (only submitted fields are changed) the specified node using the contents of 'request', the server's response (whole node info without map wrapper?) is returned in 'response'

func (*TwoStageL3ClosClient) RefreshNodeIdsByType

func (o *TwoStageL3ClosClient) RefreshNodeIdsByType(ctx context.Context, nt NodeType) ([]ObjectId, error)

func (*TwoStageL3ClosClient) SetApplicationPointConnectivityTemplates

func (o *TwoStageL3ClosClient) SetApplicationPointConnectivityTemplates(ctx context.Context, apId ObjectId, ctIds []ObjectId) error

SetApplicationPointConnectivityTemplates assigns the listed ConnectivityTemplate IDs to the application point specified by apId

func (*TwoStageL3ClosClient) SetApplicationPointsConnectivityTemplates

func (o *TwoStageL3ClosClient) SetApplicationPointsConnectivityTemplates(ctx context.Context, assignments map[ObjectId]map[ObjectId]bool) error

SetApplicationPointsConnectivityTemplates takes a map of application point ID (ObjectId) to map of policy obj (ObjectId) to bool. The application point ID (outer map key) is the ObjectID of a switch port interface, a system loopback or SVI interface, a system ID, or any other graph node ID which can serve as an "application point" for a connectivity template (endpoint policy ojb). The connectivity template ID (obj policy ID / inner map key) will be assigned or unassigned from the application point depending on the boolean value:

true: assign the policy to the application point
false: un-assign the policy from the application point

func (*TwoStageL3ClosClient) SetFabricAddressingPolicy

func (o *TwoStageL3ClosClient) SetFabricAddressingPolicy(ctx context.Context, in *TwoStageL3ClosFabricAddressingPolicy) error

func (*TwoStageL3ClosClient) SetFabricSettings

func (o *TwoStageL3ClosClient) SetFabricSettings(ctx context.Context, in *FabricSettings) error

SetFabricSettings sets the specified fabric settings

func (*TwoStageL3ClosClient) SetGenericSystemAsn

func (o *TwoStageL3ClosClient) SetGenericSystemAsn(ctx context.Context, id ObjectId, asn *uint32) error

func (*TwoStageL3ClosClient) SetGenericSystemLoopback

func (o *TwoStageL3ClosClient) SetGenericSystemLoopback(ctx context.Context, nodeId ObjectId, loopbackId int, in *GenericSystemLoopback) error

func (*TwoStageL3ClosClient) SetGenericSystemLoopbackIPs

func (o *TwoStageL3ClosClient) SetGenericSystemLoopbackIPs(ctx context.Context, gsId ObjectId, gslo GenericSystemLoopback) error

SetGenericSystemLoopbackIPs configures the loopback interface identified by gslo.LoopbackId belonging to the system identified by gsId to use the ipv4 and ipv6 addresses specified in gslo. the LoopbackNodeId and SecurityZoneId fields within gslo are ignored.

func (*TwoStageL3ClosClient) SetGenericSystemLoopbackIpv4

func (o *TwoStageL3ClosClient) SetGenericSystemLoopbackIpv4(ctx context.Context, id ObjectId, ipNet *net.IPNet, instance int) error

func (*TwoStageL3ClosClient) SetGenericSystemLoopbackIpv6

func (o *TwoStageL3ClosClient) SetGenericSystemLoopbackIpv6(ctx context.Context, id ObjectId, ipNet *net.IPNet, instance int) error

func (*TwoStageL3ClosClient) SetGenericSystemPortChannelMinMax

func (o *TwoStageL3ClosClient) SetGenericSystemPortChannelMinMax(ctx context.Context, id ObjectId, min, max int) error

func (*TwoStageL3ClosClient) SetInterfaceMapAssignments

func (o *TwoStageL3ClosClient) SetInterfaceMapAssignments(ctx context.Context, assignments SystemIdToInterfaceMapAssignment) error

SetInterfaceMapAssignments sets the supplied interface map assignments, overwriting any prior assignments with the supplied info. It returns the Blueprint config revision number.

func (*TwoStageL3ClosClient) SetLinkLagParams

func (o *TwoStageL3ClosClient) SetLinkLagParams(ctx context.Context, req *SetLinkLagParamsRequest) error

SetLinkLagParams configures the links identified in the request Links with no supplied GroupLabel will be given a unique random label making them the only members of their own group.

func (*TwoStageL3ClosClient) SetNodeTags

func (o *TwoStageL3ClosClient) SetNodeTags(ctx context.Context, nodeId ObjectId, tags []string) error

func (*TwoStageL3ClosClient) SetResourceAllocation

func (o *TwoStageL3ClosClient) SetResourceAllocation(ctx context.Context, in *ResourceGroupAllocation) error

SetResourceAllocation sets the supplied resource allocation, overwriting any prior allocations with the supplied info.

func (*TwoStageL3ClosClient) SetSecurityZoneDhcpServers

func (o *TwoStageL3ClosClient) SetSecurityZoneDhcpServers(ctx context.Context, zoneId ObjectId, IPs []net.IP) error

SetSecurityZoneDhcpServers assigns the []net.IP as DHCP relay targets for the specified security zone, overwriting whatever is there. On the Apstra side, the servers seem to be maintained as an ordered list with duplicates permitted (though the web UI sorts the data prior to display)

func (*TwoStageL3ClosClient) SetTransformIdByIfName

func (o *TwoStageL3ClosClient) SetTransformIdByIfName(ctx context.Context, systemId ObjectId, ifName string, transformId int) error

SetTransformIdByIfName attempts to update the transform ID of the named interface on the specified system. Note that it is not always possible to change the transform number, particularly when such a change would change the link speed.

func (*TwoStageL3ClosClient) SetType

func (o *TwoStageL3ClosClient) SetType(bpt BlueprintType)

SetType sets the client's internal BlueprintType value (staging, etc...). This value is in HTTP requests as a query string argument, e.g.

'?type=staging'

func (*TwoStageL3ClosClient) SystemNodeFromLinkIds

func (o *TwoStageL3ClosClient) SystemNodeFromLinkIds(ctx context.Context, linkIds []ObjectId, nodeRole SystemNodeRole) (ObjectId, error)

SystemNodeFromLinkIds performs a graph query to determine the 'system' node which is connected to either end of the specified links. When NodeRole has any value other than SystemNodeRoleNone, that role is used as an additional filter to select nodes of a specified type. For example, given a slice of spine/leaf link IDs, setting SystemNodeRoleLeaf will cause the returned ID to represent the leaf system. If more than no systems or more than one system match the criteria an error is returned.

func (*TwoStageL3ClosClient) SystemNodesFromLinkIds

func (o *TwoStageL3ClosClient) SystemNodesFromLinkIds(ctx context.Context, linkIds []ObjectId, nodeRole SystemNodeRole) ([]ObjectId, error)

SystemNodesFromLinkIds performs a graph query to determine the 'system' nodes which are connected to either end of the specified links. When NodeRole has any value other than SystemNodeRoleNone, that role is used as an additional filter to select nodes of a specified type. For example, given a slice of spine/leaf link IDs, setting SystemNodeRoleLeaf will cause the returned slice to contain only leaf switch IDs.

func (*TwoStageL3ClosClient) UpdateConfiglet

UpdateConfiglet updates a configlet imported into a blueprint.

func (*TwoStageL3ClosClient) UpdateConnectivityTemplate

func (o *TwoStageL3ClosClient) UpdateConnectivityTemplate(ctx context.Context, in *ConnectivityTemplate) error

func (*TwoStageL3ClosClient) UpdateIbaDashboard

func (o *TwoStageL3ClosClient) UpdateIbaDashboard(ctx context.Context, id ObjectId, data *IbaDashboardData) error

UpdateIbaDashboard updates an IBA Dashboard and returns an error on failure

func (*TwoStageL3ClosClient) UpdateIbaWidget

func (o *TwoStageL3ClosClient) UpdateIbaWidget(ctx context.Context, id ObjectId, c *IbaWidgetData) error

UpdateIbaWidget updates an IBA Widget.

func (*TwoStageL3ClosClient) UpdatePolicy

func (o *TwoStageL3ClosClient) UpdatePolicy(ctx context.Context, id ObjectId, data *PolicyData) error

UpdatePolicy calls PUT to replace the configuration of policy 'id' within the DC blueprint

func (*TwoStageL3ClosClient) UpdatePropertySet

func (o *TwoStageL3ClosClient) UpdatePropertySet(ctx context.Context, psid ObjectId, keys ...string) error

UpdatePropertySet updates a property set imported into a blueprint. Optionally, a set of keys can be part of the request

func (*TwoStageL3ClosClient) UpdateRemoteGateway

func (o *TwoStageL3ClosClient) UpdateRemoteGateway(ctx context.Context, id ObjectId, in *RemoteGatewayData) error

UpdateRemoteGateway updates the remote / external gateway specified by id using the supplied parameters

func (*TwoStageL3ClosClient) UpdateRoutingPolicy

func (o *TwoStageL3ClosClient) UpdateRoutingPolicy(ctx context.Context, id ObjectId, in *DcRoutingPolicyData) error

UpdateRoutingPolicy modifies the blueprint routing policy specified by 'id' according to the supplied *DcRoutingPolicyData.

func (*TwoStageL3ClosClient) UpdateSecurityZone

func (o *TwoStageL3ClosClient) UpdateSecurityZone(ctx context.Context, zoneId ObjectId, cfg *SecurityZoneData) error

UpdateSecurityZone replaces the configuration of zone zoneId with the supplied CreateSecurityZoneCfg

func (*TwoStageL3ClosClient) UpdateVirtualNetwork

func (o *TwoStageL3ClosClient) UpdateVirtualNetwork(ctx context.Context, id ObjectId, in *VirtualNetworkData) error

UpdateVirtualNetwork updates the virtual network specified by ID using the VirtualNetworkData and HTTP method PUT.

type TwoStageL3ClosConfiglet

type TwoStageL3ClosConfiglet struct {
	Id   ObjectId
	Data *TwoStageL3ClosConfigletData
}

type TwoStageL3ClosConfigletData

type TwoStageL3ClosConfigletData struct {
	Label     string
	Condition string
	Data      *ConfigletData
}

type TwoStageL3ClosFabricAddressingPolicy

type TwoStageL3ClosFabricAddressingPolicy struct {
	Ipv6Enabled *bool   `json:"ipv6_enabled,omitempty"`
	EsiMacMsb   *uint8  `json:"esi_mac_msb,omitempty"`
	FabricL3Mtu *uint16 `json:"fabric_l3_mtu,omitempty"`
}

type TwoStageL3ClosMutex

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

func (*TwoStageL3ClosMutex) BlueprintID

func (o *TwoStageL3ClosMutex) BlueprintID() ObjectId

BlueprintID returns the Blueprint ID

func (*TwoStageL3ClosMutex) GetMessage

func (o *TwoStageL3ClosMutex) GetMessage() string

GetMessage returns the message embedded in the mutex

func (*TwoStageL3ClosMutex) Lock

Lock attempts to assert the blueprint mutex, repeatedly trying until the context.Context expires or it encounters an error.

func (*TwoStageL3ClosMutex) SetMessage

func (o *TwoStageL3ClosMutex) SetMessage(msg string) error

SetMessage sets the lock message embedded in the mutex

func (*TwoStageL3ClosMutex) TryLock

func (o *TwoStageL3ClosMutex) TryLock(ctx context.Context) error

TryLock attempts to assert the blueprint mutex without blocking.

func (*TwoStageL3ClosMutex) Unlock

func (o *TwoStageL3ClosMutex) Unlock(ctx context.Context) error

Unlock releases the mutex

type TwoStageL3ClosPropertySet

type TwoStageL3ClosPropertySet struct {
	Id         ObjectId        `json:"id"`
	Label      string          `json:"label"`
	Stale      bool            `json:"stale"`
	Values     json.RawMessage `json:"values"`
	ValuesYaml string          `json:"values_yaml"`
}

type TwoStageL3ClosRackRequest

type TwoStageL3ClosRackRequest struct {
	PodId      ObjectId
	RackTypeId ObjectId
}

type VNI

type VNI uint32

type VersionResponse

type VersionResponse struct {
	Major   string `json:"major"`
	Version string `json:"version"`
	Build   string `json:"build"`
	Minor   string `json:"minor"`
}

type VirtualInfraMgrInfo

type VirtualInfraMgrInfo struct {
	ConnectionState              string    `json:"connection_state"`
	LastSuccessfulCollectionTime time.Time `json:"last_successful_collection_time"`
	ServiceEnabled               bool      `json:"service_enabled"`
	ManagementIp                 string    `json:"management_ip"`
	SystemId                     string    `json:"system_id"`
	AgentId                      string    `json:"agent_id"`
	VirtualInfraType             string    `json:"virtual_infra_type"`
}

type VirtualNetwork

type VirtualNetwork struct {
	Id   ObjectId
	Data *VirtualNetworkData
}

type VirtualNetworkData

type VirtualNetworkData struct {
	DhcpService               DhcpServiceEnabled
	Ipv4Enabled               bool
	Ipv4Subnet                *net.IPNet
	Ipv6Enabled               bool
	Ipv6Subnet                *net.IPNet
	L3Mtu                     *int
	Label                     string
	ReservedVlanId            *Vlan
	RouteTarget               string
	RtPolicy                  *RtPolicy
	SecurityZoneId            ObjectId
	SviIps                    []SviIp
	VirtualGatewayIpv4        net.IP
	VirtualGatewayIpv6        net.IP
	VirtualGatewayIpv4Enabled bool
	VirtualGatewayIpv6Enabled bool
	VnBindings                []VnBinding
	VnId                      *VNI
	VnType                    VnType
	VirtualMac                net.HardwareAddr
}

type VirtualNetworkPolicy

type VirtualNetworkPolicy struct {
	OverlayControlProtocol OverlayControlProtocol
}

type Vlan

type Vlan uint16

type VnBinding

type VnBinding struct {
	//AccessSwitches []interface `json:"access_switches"`
	AccessSwitchNodeIds []ObjectId `json:"access_switch_node_ids"`
	//Role                string     `json:"role"`      // so far: "leaf", possibly graphdb "role" element
	SystemId ObjectId `json:"system_id"` // graphdb node id of a leaf (so far) switch
	VlanId   *Vlan    `json:"vlan_id"`   // optional (auto-assign)

}

type VnType

type VnType int

func AllVirtualNetworkTypes

func AllVirtualNetworkTypes() []VnType

AllVirtualNetworkTypes returns the []VnType representing each supported VnType

func (*VnType) FromString

func (o *VnType) FromString(s string) error

func (VnType) String

func (o VnType) String() string

type VniPool

type VniPool IntPool

VniPool is the public structure used to convey query responses about Vni pools.

type VniPoolRequest

type VniPoolRequest IntPoolRequest

VniPoolRequest is the public structure used to create/update an ASN pool.

Source Files

Jump to

Keyboard shortcuts

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