package
0.0.0-20241209203403-595a3a1a838b
Repository: https://github.com/keithwiles/opi-api.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
RegisterCloudInfraServiceHandler registers the http handlers for service CloudInfraService to "mux".
RegisterCloudInfraServiceHandlerClient registers the http handlers for service CloudInfraService to "mux".
RegisterCloudInfraServiceHandlerFromEndpoint is same as RegisterCloudInfraServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterCloudInfraServiceHandlerServer registers the http handlers for service CloudInfraService to "mux".
No description provided by the author

# Constants

DNS ALG.
FTP ALG.
MSRPC ALG.
RTSP ALG.
SUNRPC ALG.
TFTP ALG.
unspecified.
both.
disabled (-- api-linter: core::0126::unspecified=disabled aip.dev/not-precedent: zero is disabled, not unspecified.
inherit.
receive.
send.
uknown.
apple-talk.
banyan.
bbn-1822.
dec net.
e163.
e164.
nsap.
f69.
hdlc.
ieee 802.
ipv4.
ipv4 tna.
ipv6.
ipv6 tna.
ipx.
l2vpn.
nsap.
nsap tna.
other.
vpn ipv4.
vpn ipv6.
x121.
AFI_IPV4.
AFI_IPv6.
AFI_L2VPN.
AFI_UNSPECIFIED.
advertised.
pending withdrawal.
suppressed.
unspecified.
withdrawn.
four bytes.
two bytes.
unspecified.
toggle session.
send all routes to peer and request route refresh from peer.
request route refresh from peer.
send all routes to peer.
unspecified.
active.
inactive.
not tracked.
unspecified.
activation failed.
down.
going down.
going up.
unspecified.
up.
egp.
igp.
incomplete.
unspecified.
RR_CLIENT.
RR_MESHED_CLIENT.
RR_UNSPECIFIED.
active.
connect.
open-established.
idle.
open-confirm.
open-sent.
unspecified.
ebgp.
ibgp.
none (per protocol).
unspecified.
admin distance.
as path lengt.
cluster length.
ebpg vs.
reason identifier (-- api-linter: core::0140::abbreviations=disabled aip.dev/not-precedent: --).
local origin preferred.
origin tie.
local preference.
med.
not considered (-- api-linter: core::0126::unspecified=disabled aip.dev/not-precedent: zero is not-considered, not unspecified.
origin based.
path id.
path next to cst.
peer address.
peer address type.
peer port.
preferenc existing.
route is best.
weight based.
SAFI_EVPN.
SAFI_UNICAST.
SAFI_UNSPECIFIED.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
interface is down.
unknown.
interface is up.
inband management/control interface.
host visible PF/VF device.
L3 interface.
loopback interface.
unspecified.
uplink interface.
uplink port-channel interface.
l2 mapping.
l3 mapping.
unspecified.
MAPPING_TYPE_LB_VIP is used for mappings that represent load balancer service VIP.
MAPPING_TYPE_SERVICE is used for mappings that represent service endpoints.
unspecified.
MAPPING_TYPE_VPC is used for regular VPC endpoints and is the default.
copper cable.
fiber cable.
media not connected.
ECMP for overlay routes pointing to VTEPs.
ECMP for underlay VTEPs pointing to nexthops.
unspecified.
ip.
overlay.
underlay.
unspecified.
learned from AFM.
learned from peer.
created by itself.
unspecified.
Broadcast type.
Point to Point type.
IfNetwork Type Unspecified.
activation failed.
down.
going down.
going up.
unspecified.
up.
Type 1.
Type 1.
Redist Metric Unspecified.
BGP.
Connection.
Static.
Redist Unspecified.
OSPF Version 2.
OSPF Version 3.
OSPF Version not specified and assume v2.
POLICY_RULE_FORMAT_COMPACT is used when rules contain list of source IP, destination IP, src port range, destination port ranges as match conditions In this format, ALL the rules must use SrcIPList, DstIPList, PortList, ICMPMatchList attributes only, whereever applicable.
POLICY_RULE_FORMAT_FLATTENED is used when xPU expands the user configured rules so that each rule has only single source IP address/prefix/range, destination IP address/prefix/range, source port range, destination port range as match conditions In this format none of the rules must use SrcIPList, DstIPList, PortList, ICMPMatchList attributes, wherever applicable.
POLICY_RULE_FORMAT_UNSPECIFIED indicates that user has not set format explicitly, in which case POLICY_RULE_FORMAT_FLATTENED is assumed for an implementation is agnostic to flattened or compressed rules.
port is admin disabled.
port admin state not configured.
port is admin enabled.
FireCode (FC) FEC.
ReedSolomon (RS) FEC.
Disable FEC.
auto negotiation configured.
auto negotiation complete.
auto negotiation dfe tuning.
auto negotiation disabled.
auto negotiation signal detect.
auto negotiation started.
auto negotiation wait HCD.
clear mac remote faults.
dfe disabled.
dfe pcal continuous.
dfe start ical.
dfe start pcal.
dfe tuning enabled.
dfe wait ical.
dfe wait pcal.
enabled.
mac configured.
seredes configured.
signal detected.
unspecified1.
link up.
mac faults cleared.
wait mac sync.
wait phy link up.
serdes ready.
MAC loopback.
PHY/Serdes loopback.
No loopback.
port link status is down.
unknown.
port is linked up.
Link level pause.
PFC.
Disable Pause.
port speed is 100Gbps.
port speed is 100Mbps.
port speed is 10Gbps.
port speed is 10Mbps.
port speed is 1Gbps.
port speed is 200Gbps.
port speed is 25Gbps.
port speed is 400Gbps.
port speed is 40Gbps.
port speed is 50Gbps.
unconfigured.
data ethernet.
management ethernet.
unspecified.
QSFP 100G ACC.
Fiber QSFP 100G AOC.
Copper QSFP 100G CR4.
QSFP 100G CXWDM4.
QSFP 100G ER4.
QSFP 100G LR4.
QSFP 100G PSM4.
QSFP 100G SR4.
200G CR4.
QSFP 40G AOC.
QSFP 40G CR4.
QSFP 40G ER4.
QSFP 40G LR4.
QSFP 40G SR4.
50G CR2.
50G CR2 FC.
SFP 100G BASE T.
SFP 10G AOC.
SFP 10G CU.
SFP 10G ER.
SFP 10G LR.
SFP 10G LRM.
SFP 10G SR.
SFP 10G BASE T.
SFP 125G ACC.
SFP 25G AOC.
25G CR L.
25G CR N.
25G CR S.
SFP 25G ER.
SFP 25G LR.
SFP 25G SR.
unspecified.
state - inserted.
state - pending.
state - sprom read.
state - sprom read error.
state - removed.
route pointing to Internet.
route used for internal/shared services.
unspecified.
VPC internal routes.
/ TENANT security policy objects are attached to tenant VPCs.
UNDERLAY security policy object is singleton object per DSC.
unspecified.
tunnel type for Internet Gateway.
tunnel type for inter data center traffic.
tunnel type ipsec.
tunnel type for provider services.
unspecified.
tunnel pointing to an intermediate Virtual Network Function (VNF) devices.
tunnel type for east-traffic workloads with in a data center.
control.
tenant.
underlay.
unspecified.

# Variables

Enum value maps for ALGType.
Enum value maps for ALGType.
Enum value maps for BgpAddPathCapNeg.
Enum value maps for BgpAddPathCapNeg.
Enum value maps for BGPAddrType.
Enum value maps for BGPAddrType.
Enum value maps for BGPAfi.
Enum value maps for BGPAfi.
Enum value maps for BgpAroAdvertState.
Enum value maps for BgpAroAdvertState.
Enum value maps for BgpAsSize.
Enum value maps for BgpAsSize.
Enum value maps for BGPClearRouteOptions.
Enum value maps for BGPClearRouteOptions.
Enum value maps for BgpNlriIsActive.
Enum value maps for BgpNlriIsActive.
Enum value maps for BGPOperState.
Enum value maps for BGPOperState.
Enum value maps for BGPOriginAttr.
Enum value maps for BGPOriginAttr.
Enum value maps for BgpPeerRR.
Enum value maps for BgpPeerRR.
Enum value maps for BgpPeerSessionState.
Enum value maps for BgpPeerSessionState.
Enum value maps for BgpPeerType.
Enum value maps for BgpPeerType.
Enum value maps for BGPRouteReason.
Enum value maps for BGPRouteReason.
Enum value maps for BGPSafi.
Enum value maps for BGPSafi.
CloudInfraService_ServiceDesc is the grpc.ServiceDesc for CloudInfraService service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for IfStatus.
Enum value maps for IfStatus.
Enum value maps for IfType.
Enum value maps for IfType.
Enum value maps for MappingKeyType.
Enum value maps for MappingKeyType.
Enum value maps for MappingType.
Enum value maps for MappingType.
Enum value maps for MediaType.
Enum value maps for MediaType.
Enum value maps for NextHopGroupType.
Enum value maps for NextHopGroupType.
Enum value maps for NextHopType.
Enum value maps for NextHopType.
Enum value maps for NLRISrc.
Enum value maps for NLRISrc.
Enum value maps for OspfIfNetworkType.
Enum value maps for OspfIfNetworkType.
Enum value maps for OSPFOperState.
Enum value maps for OSPFOperState.
Enum value maps for OSPFRedistMetricType.
Enum value maps for OSPFRedistMetricType.
Enum value maps for OSPFRedistType.
Enum value maps for OSPFRedistType.
Enum value maps for OSPFVersion.
Enum value maps for OSPFVersion.
Enum value maps for PolicyRuleFormat.
Enum value maps for PolicyRuleFormat.
Enum value maps for PortAdminState.
Enum value maps for PortAdminState.
Enum value maps for PortFecType.
Enum value maps for PortFecType.
Enum value maps for PortLinkFSM.
Enum value maps for PortLinkFSM.
Enum value maps for PortLoopBackMode.
Enum value maps for PortLoopBackMode.
Enum value maps for PortOperState.
Enum value maps for PortOperState.
Enum value maps for PortPauseType.
Enum value maps for PortPauseType.
Enum value maps for PortSpeed.
Enum value maps for PortSpeed.
Enum value maps for PortType.
Enum value maps for PortType.
Enum value maps for PortXcvrPid.
Enum value maps for PortXcvrPid.
Enum value maps for PortXcvrState.
Enum value maps for PortXcvrState.
Enum value maps for RouteClass.
Enum value maps for RouteClass.
Enum value maps for SecurityPolicyType.
Enum value maps for SecurityPolicyType.
Enum value maps for TunnelType.
Enum value maps for TunnelType.
Enum value maps for VPCType.
Enum value maps for VPCType.

# Structs

ALC configuration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BGP AdjRibOut object, is a read only object specifiying BGP RIB adjacencies spec is used to query specific adjacencies.
BGP Adj-RIB-Out spec for get operations empty for now; add support for more filtered gets in future.
BGP Adj-RIB-Out table contains set of routes advertised to all peers.
BGP standard community.
BGPMaxPrefix.
BGPMaxPrefixRestart.
BGP NLRI prefix object, this object is not conifgured by the user rather populated by the BGP automatically, spec is defined for get operations.
BGP NLRI prefix filter object, returned in get response for BGP prefixes.
BGP NLRI prefix spec object.
BGP NLRI prefix table.
BGP peer object.
BGP peer AF object.
BGP peer AF configurations.
BGP peer AF status.
BGP peer configurations.
BGP peer status.
BGPRouteMap.
BGP Router object.
BGP Router configuration.
operational status of BGP.
Inband control interface configuration.
BgpPeerAf Requests/Responses Create BgpPeerAf Request.
BgpPeer Requests/Responses Create BgpPeer Request.
Bgp Requests/Responses Create BgpRouter Request.
Create Device Request.
Create Interface Request.
Create Mapping Request.
Create NextHopGroup Request.
Create NextHop Request.
Create OspfArea Request.
Create OspfIfNetwork Request.
Create OSPF Router Request.
Create Route Request.
Create RouteTable Request.
Create SecurityPolicy Request.
Create SecurityProfile Request.
Create SecurityRule Request.
Create Subnet Request.
Create Tunnel Request.
Create UnderlayRoute Request.
Create Vnic Request.
Create VPCPeer Request.
Create Vpc Request.
Delete bgp peer af request.
Delete BGP Peer request.
Delete BgpRouter request.
Delete device request.
Delete interface request.
Delete mapping request.
Delete nexthopgroup request.
Delete nexthop request.
Delete OspfArea request.
Delete OspfIfNetwork request.
Delete OSPF request.
Delete route request.
Delete routetable request.
Delete securitypolicy request.
Delete securityprofile request.
Delete securityrule request.
Delete subnet request.
Delete Tunnel request.
Delete underlayroute request.
Delete vnic request.
Delete vpcpeer request.
Delete vpc request.
device level network configuration and status.
device capabilities indicate the capabilities of software/hardware as exposed by current firmware of the device.
device capabilities for dynamic routing.
device capabilities for network security policies.
device's network configuration.
device's network status.
DNS ALG specific options these options are applicable to DNS request messages only.
DropNexthop is used to blackhole the traffic.
FTP ALG specific options.
Get bgp peer af request.
Get bgp peer request.
Get bgp request.
Get DeviceCapabilities Request.
Get device request.
Get interface request.
Get mapping request.
Get nexthopgroup request.
Get nexthop request.
Get OspfArea request.
Get OspfIfNetwork request.
Get OSPF request.
Get port request.
Get route request.
Get routetable request.
Get securitypolicy request.
Get securityprofile request.
Get securityrule request.
Get subnet request.
Get Tunnel request.
Get underlayroute request.
Get vnic request.
Get vpcpeer request.
Get vpc request.
HostIfSpec represents a host visisble device (e.g.
operational status of host interfaces.
interface - ethernet interface (layer2 and layer3 configuration).
InterfaceSpec is used to add or update of an interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
operational status of an interface, if any.
No description provided by the author
No description provided by the author
No description provided by the author
IP nexthop information.
L2MappingKey is the 2nd-ary key of the remote MAC mapping.
L3 interface configuration.
L3MappingKey is the 2nd-ary key of the remote IP mapping.
List bgp peer af request.
List bgp peer af response.
List bgp peer request.
List bgp peer response.
List BgpRouter request.
List BgpRouter response.
List device request.
List device response.
List interface request.
List interface response.
List mapping request.
List mapping response.
List nexthopgroup request.
List nexthopgroup response.
List nexthop request.
List nexthop response.
List OspfArea request.
List OspfArea response.
List OspfIfNetwork request.
List OspfIfNetwork response.
List OSPF request.
List OSPF response.
List port request.
List port response.
List route request.
List route response.
List routetable request.
List routetable response.
List securitypolicy request.
List securitypolicy response.
List securityprofile request.
List securityprofile response.
List securityrule request.
List securityrule response.
List subnet request.
List subnet response.
List Tunnel request.
List Tunnel response.
List underlayroute request.
List underlayroute response.
List vnic request.
List vnic response.
List vpcpeer request.
List vpcpeer response.
List vpc request.
List vpc response.
Loopback interface configuration.
operational status of loopback interface.
mapping object.
Filter criteria for a mapping lookup api.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MappingSpec captures configuration of each mapping NOTE: Mapping is either on the local host/TEP or remote TEP.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
operational status of a mapping.
MgmtNetworkSpec captures all the management network related parameters.
MSRPC ALG specific options.
nexthop object.
nexthop group object.
nexthop group lookup request.
No description provided by the author
No description provided by the author
nexthop group specification - a nextgroup consists of bunch of nexthops.
operational status of nexthop group, if any.
nexthop get request.
No description provided by the author
No description provided by the author
nexthop specification.
No description provided by the author
No description provided by the author
No description provided by the author
operational status of nexthop, if any.
No description provided by the author
No description provided by the author
OspfArea object.
OspfAreaSpec configuration.
OspfIfNetwork.
OspfIfNetworkSpec configuration.
MD5 Auth.
OSPFRedistSpec configuration.
OSPF Config object.
OSPF configuration.
OverlayNextHopIPInfo captures list of overlay IP destinations for a given route.
Overlay nexthop information.
overlay next hop status.
PCIe functions to be configured on the device.
PolicyLookupMatch captures all the policy lookup match conditions.
PolicyLookupResult captures the results of one security policy lookup.
link level configuration.
port's link state machine transition record.
port link status.
port configuration.
port status.
transciever status.
route object.
route attributes Routes types: static route, internet route, service routes, etc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
route identifier.
route configuration information.
route specification.
operational status of the route, if any.
route table object.
Route table - a prioritized list of static routes/prefixes used for forwarding traffic within a VPC, across VPCs or to the outside world Individual routes within the route table can be updated using Route object.
operational status of the route table, if any.
security policy object.
SecurityPolicyLookup is used to fetch security policy based on various lookup criteria.
No description provided by the author
given a vnic and policy direction (ingress/egress) and packet fields, evaluate all the policies and return the results.
No description provided by the author
security policy configuration.
operational status of security policy, if any.
security profile object.
security profile - defaults for network security behavior - currently security profile object is global and only a singleton object, any attempt to create multiple objects will be treated as an error - if no object is created, indicated default values will be used - all timeouts specified in this object are in seconds.
operational status of security profile, if any.
security rule object.
security rule attributes.
SecurityRuleInfo is a single rule in the security policy.
security rule configuration.
operational status of the security rule, if any.
subnet object.
SubnetSpec captures subnet specific configuration.
operational status of the subnet, if any.
SunRPC ALG specific options.
critical alerts effecting the health of the system.
system events happened during device operations.
tunnel object.
tunnel configuration - identified by 3-tuple (LocalIP, RemoteIP, encap) If multiple tunnels with same RemoteIP address are created, they should have same Type attribute value i.e., different tunnels with same IP can't have different tunnel type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
operational status of the tunnel, if any.
Underlay nexthop information.
underlay next hop status.
Underlay Route can be static or dynamic underlay route.
UnderlayRouteLookupKey can be used to query one or more routes based on various fields.
control plane static route configuration.
Underlay Route status for a control plane static or dynamic route.
UnimplementedCloudInfraServiceServer must be embedded to have forward compatible implementations.
Update bgp peer af request.
Update bgp peer request.
Update BgpRouter request.
Update device request.
Update interface request.
Update mapping request.
Update nexthopgroup request.
Update nexthop request.
Update OspfArea request.
Update OspfIfNetwork request.
Update OSPF request.
Update port request.
Update route request.
Update routetable request.
Update securitypolicy request.
Update securityprofile request.
Update securityrule request.
Update subnet request.
Update Tunnel request.
Update underlayroute request.
Update vnic request.
Update vpcpeer request.
Update vpc request.
operational status of uplink interface.
Uplink port-channel configuration; interface type IF_TYPE_UPLINK_PC.
Uplink configuration; interface type IF_TYPE_UPLINK.
vnic is a generic abstraction representing tenant workload's interface tenant workload could be a VM, container or bare-metal.
vnic configuration.
No description provided by the author
No description provided by the author
operational status of Vnic, if any.
Virtual Private Cloud object.
Virtual Private Cloud Peer (aka.
Inter VPC routing: if a route in a route table points to VPCPeerNhInfo that contains peer VPC's uuid and the route table, to launch a lookup in the route table.
VPCPeerSpec captures configuration for a VPC peering relation Given two vpcs, only one vpc peering objects needs to be created as the vpc peering is commutative relation.
operational status of a VPC peering, if any.
VpcSpec captures VPC configuration.
operational status of a VPC, if any.

# Interfaces

CloudInfraServiceClient is the client API for CloudInfraService service.
CloudInfraServiceServer is the server API for CloudInfraService service.
UnsafeCloudInfraServiceServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

ALG specifices with Application Level Gateway (ALG) should be invoked when a rule match happens.
bgp add path capability negotiation.
bgp address type.
BGP address family identifier.
BGP ARO Advertisement State.
bgp as size.
clear route request's options.
NLRI active values.
bgp operational status.
bgp origin attribute.
BGP peer Route Reflector client.
BGP peer session's last_state.
bgp peer type.
BGP Reason for not best route.
BGP sub-address family identitfier.
IfStatus status reflects the operational status of Interface (-- api-linter: core::0216::synonyms=disabled aip.dev/not-precedent: interface status is up or down, not interface state.
types of interfaces.
mapping key type can be L2 or L3.
MappingType captures the type of the mapping.
port's media type.
type of the nexthop group.
next hop type.
NLRI source.
IfNetwork Types.
OSPFOperState operational state.
OSPF Redist Metric Type.
OSPF Redist Type.
OSPF Version Number.
PolicyRuleFormat captures what format is used for the rules in a given SecurityPolicySpec object.
PortAdminState specifies if the port is enabled (admin up) or disabled (admin down).
Forward Error Correction.
port link state.
loop back mode configuration.
PortOperState reflects the current status of the port.
port pause type.
PortSpeed specifies the speed of the port.
port type - date or management.
transciever product id.
port's transceiver state.
RouteClass captures different types/classes of routes.
types of security policies.
TunnelType defines the role of the tunnel.
type of the virtual private cloud.