Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Google Cloud Hybrid Connectivity

Connection Parameters

Name
Required?
Description

Private Key JSON

Required

The contents of the private key JSON file created when setting up a service account.

Metric Collection

Controls which metrics get requested from GCP's Stackdriver API.

Projects

Required

A comma separated whitelist of project IDs. If the wildcard "*" is used, resources will be collected from all available projects.

Regions

Required

A comma separated whitelist of regions. At least one region must be specified.

Connection Timeout

The number of seconds to allow for connecting to the target.

Metrics

Cloud Router

Name
Description

BGP Received Routes

Current number of routes received on a bgp session.

BGP Sent Routes

Current number of routes sent on a bgp session.

BGP Session Status

Indicator for successful bgp session establishment.

BGP Sessions Down

Number of BGP sessions on the router that are down.

BGP Sessions Up

Number of BGP sessions on the router that are up.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Name

Name of the resource. Provided by the client when the resource is created.

Network

URI of the network to which this router belongs.

Project ID

The identifier of the project that the router belongs to.

Received Routes

Current number of best routes received by router.

Region

The region in which the router is present.

Router ID

The unique ID of the router.

Router Status

Router status, up or down.

Sent Routes

Current number of routes sent by router.

VPN Gateway

Name
Description

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Forwarding Rules

A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.

Gateway ID

The unique identifier for the gateway.

Gateway Name

The name of the gateway.

Incoming Packets Dropped (Packets per Second)

Ingress (received from peer VPN) packets dropped for tunnel.

Kind

Type of resource. Always compute#targetVpnGateway for target VPN gateways.

Network

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

Outgoing Packets Dropped (Packets per Second)

Egress (directed to peer VPN) packets dropped for tunnel.

Project ID

The identifier for the project this gateway belongs to.

Received Data (Bytes per Second)

Ingress (received from peer VPN) data for tunnel.

Region

The region in which the gateway resides.

Self Link

Server-defined URL for the resource.

Sent Data (Bytes per Second)

Egress (directed to peer VPN) data for tunnel.

Status

The status of the VPN gateway.

Tunnel Established

Indicates successful tunnel establishment if > 0.

Tunnels

A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.

VPN Tunnel

Name
Description

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Detailed Status

Detailed status message for the VPN tunnel.

Gateway ID

The unique identifier for the parent gateway.

Gateway Name

The name of the parent gateway.

Ike Version

IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.

Incoming Packets Dropped (Packets per Second)

Ingress (received from peer VPN) packets dropped for tunnel.

Kind

Type of resource. Always compute#vpnTunnel for VPN tunnels.

Local Traffic Selector

Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.

Outgoing Packets Dropped (Packets per Second)

Egress (directed to peer VPN) packets dropped for tunnel.

Peer Ip

IP address of the peer VPN gateway. Only IPv4 is supported.

Project ID

The identifier for the project this gateway belongs to.

Received Data (Bytes per Second)

Ingress (received from peer VPN) data for tunnel.

Region

The region in which the tunnel resides.

Remote Traffic Selector

Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.

Router

URL of router resource to be used for dynamic routing.

Self Link

Server-defined URL for the resource.

Sent Data (Bytes per Second)

Egress (directed to peer VPN) data for tunnel.

Shared Secret

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

Shared Secret Hash

Hash of the shared secret.

Status

The status of the VPN tunnel.

Target VPN Gateway

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

Tunnel Established

Indicates successful tunnel establishment if > 0.

Tunnel Name

The name of the tunnel.