Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
nxos.getBgpPeerAddressFamilyRouteControl
Explore with Pulumi AI
This data source can read the BGP peer address family route control configuration.
- API Documentation: bgpRtCtrlP
 
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Pulumi.Nxos;
return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpPeerAddressFamilyRouteControl.Invoke(new()
    {
        Address = "192.168.0.1",
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        Direction = "in",
        Vrf = "default",
    });
});
package main
import (
	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.LookupBgpPeerAddressFamilyRouteControl(ctx, &nxos.LookupBgpPeerAddressFamilyRouteControlArgs{
			Address:       "192.168.0.1",
			AddressFamily: "ipv4-ucast",
			Asn:           "65001",
			Direction:     "in",
			Vrf:           "default",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.NxosFunctions;
import com.pulumi.nxos.inputs.GetBgpPeerAddressFamilyRouteControlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = NxosFunctions.getBgpPeerAddressFamilyRouteControl(GetBgpPeerAddressFamilyRouteControlArgs.builder()
            .address("192.168.0.1")
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .direction("in")
            .vrf("default")
            .build());
    }
}
import pulumi
import pulumi_nxos as nxos
example = nxos.get_bgp_peer_address_family_route_control(address="192.168.0.1",
    address_family="ipv4-ucast",
    asn="65001",
    direction="in",
    vrf="default")
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";
const example = nxos.getBgpPeerAddressFamilyRouteControl({
    address: "192.168.0.1",
    addressFamily: "ipv4-ucast",
    asn: "65001",
    direction: "in",
    vrf: "default",
});
variables:
  example:
    fn::invoke:
      Function: nxos:getBgpPeerAddressFamilyRouteControl
      Arguments:
        address: 192.168.0.1
        addressFamily: ipv4-ucast
        asn: '65001'
        direction: in
        vrf: default
Using getBgpPeerAddressFamilyRouteControl
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBgpPeerAddressFamilyRouteControl(args: GetBgpPeerAddressFamilyRouteControlArgs, opts?: InvokeOptions): Promise<GetBgpPeerAddressFamilyRouteControlResult>
function getBgpPeerAddressFamilyRouteControlOutput(args: GetBgpPeerAddressFamilyRouteControlOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerAddressFamilyRouteControlResult>def get_bgp_peer_address_family_route_control(address: Optional[str] = None,
                                              address_family: Optional[str] = None,
                                              asn: Optional[str] = None,
                                              device: Optional[str] = None,
                                              direction: Optional[str] = None,
                                              vrf: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetBgpPeerAddressFamilyRouteControlResult
def get_bgp_peer_address_family_route_control_output(address: Optional[pulumi.Input[str]] = None,
                                              address_family: Optional[pulumi.Input[str]] = None,
                                              asn: Optional[pulumi.Input[str]] = None,
                                              device: Optional[pulumi.Input[str]] = None,
                                              direction: Optional[pulumi.Input[str]] = None,
                                              vrf: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerAddressFamilyRouteControlResult]func LookupBgpPeerAddressFamilyRouteControl(ctx *Context, args *LookupBgpPeerAddressFamilyRouteControlArgs, opts ...InvokeOption) (*LookupBgpPeerAddressFamilyRouteControlResult, error)
func LookupBgpPeerAddressFamilyRouteControlOutput(ctx *Context, args *LookupBgpPeerAddressFamilyRouteControlOutputArgs, opts ...InvokeOption) LookupBgpPeerAddressFamilyRouteControlResultOutput> Note: This function is named LookupBgpPeerAddressFamilyRouteControl in the Go SDK.
public static class GetBgpPeerAddressFamilyRouteControl 
{
    public static Task<GetBgpPeerAddressFamilyRouteControlResult> InvokeAsync(GetBgpPeerAddressFamilyRouteControlArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpPeerAddressFamilyRouteControlResult> Invoke(GetBgpPeerAddressFamilyRouteControlInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetBgpPeerAddressFamilyRouteControlResult> getBgpPeerAddressFamilyRouteControl(GetBgpPeerAddressFamilyRouteControlArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: nxos:index/getBgpPeerAddressFamilyRouteControl:getBgpPeerAddressFamilyRouteControl
  arguments:
    # arguments dictionaryThe following arguments are supported:
getBgpPeerAddressFamilyRouteControl Result
The following output properties are available:
- Address string
 - Peer address.
 - Address
Family string - Address Family.
 - Asn string
 - Autonomous system number.
 - Direction string
 - Route Control direction.
 - Id string
 - The distinguished name of the object.
 - Route
Map stringName  - Route Control Route-Map name.
 - Vrf string
 - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- Address string
 - Peer address.
 - Address
Family string - Address Family.
 - Asn string
 - Autonomous system number.
 - Direction string
 - Route Control direction.
 - Id string
 - The distinguished name of the object.
 - Route
Map stringName  - Route Control Route-Map name.
 - Vrf string
 - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- address String
 - Peer address.
 - address
Family String - Address Family.
 - asn String
 - Autonomous system number.
 - direction String
 - Route Control direction.
 - id String
 - The distinguished name of the object.
 - route
Map StringName  - Route Control Route-Map name.
 - vrf String
 - VRF name.
 - device String
 - A device name from the provider configuration.
 
- address string
 - Peer address.
 - address
Family string - Address Family.
 - asn string
 - Autonomous system number.
 - direction string
 - Route Control direction.
 - id string
 - The distinguished name of the object.
 - route
Map stringName  - Route Control Route-Map name.
 - vrf string
 - VRF name.
 - device string
 - A device name from the provider configuration.
 
- address str
 - Peer address.
 - address_
family str - Address Family.
 - asn str
 - Autonomous system number.
 - direction str
 - Route Control direction.
 - id str
 - The distinguished name of the object.
 - route_
map_ strname  - Route Control Route-Map name.
 - vrf str
 - VRF name.
 - device str
 - A device name from the provider configuration.
 
- address String
 - Peer address.
 - address
Family String - Address Family.
 - asn String
 - Autonomous system number.
 - direction String
 - Route Control direction.
 - id String
 - The distinguished name of the object.
 - route
Map StringName  - Route Control Route-Map name.
 - vrf String
 - VRF name.
 - device String
 - A device name from the provider configuration.
 
Package Details
- Repository
 - nxos lbrlabs/pulumi-nxos
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
nxosTerraform Provider.