Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getBgpPeerAddressFamilyRouteControl
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getBgpPeerAddressFamilyRouteControl

Explore with Pulumi AI

Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

This data source can read the BGP peer address family route control configuration.

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",
    });

});
Copy
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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getBgpPeerAddressFamilyRouteControl
      Arguments:
        address: 192.168.0.1
        addressFamily: ipv4-ucast
        asn: '65001'
        direction: in
        vrf: default
Copy

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>
Copy
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]
Copy
func LookupBgpPeerAddressFamilyRouteControl(ctx *Context, args *LookupBgpPeerAddressFamilyRouteControlArgs, opts ...InvokeOption) (*LookupBgpPeerAddressFamilyRouteControlResult, error)
func LookupBgpPeerAddressFamilyRouteControlOutput(ctx *Context, args *LookupBgpPeerAddressFamilyRouteControlOutputArgs, opts ...InvokeOption) LookupBgpPeerAddressFamilyRouteControlResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetBgpPeerAddressFamilyRouteControlResult> getBgpPeerAddressFamilyRouteControl(GetBgpPeerAddressFamilyRouteControlArgs args, InvokeOptions options)
public static Output<GetBgpPeerAddressFamilyRouteControlResult> getBgpPeerAddressFamilyRouteControl(GetBgpPeerAddressFamilyRouteControlArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getBgpPeerAddressFamilyRouteControl:getBgpPeerAddressFamilyRouteControl
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Address This property is required. string
Peer address.
AddressFamily This property is required. string
Address Family.
Asn This property is required. string
Autonomous system number.
Direction This property is required. string
Route Control direction.
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
Address This property is required. string
Peer address.
AddressFamily This property is required. string
Address Family.
Asn This property is required. string
Autonomous system number.
Direction This property is required. string
Route Control direction.
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
address This property is required. String
Peer address.
addressFamily This property is required. String
Address Family.
asn This property is required. String
Autonomous system number.
direction This property is required. String
Route Control direction.
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.
address This property is required. string
Peer address.
addressFamily This property is required. string
Address Family.
asn This property is required. string
Autonomous system number.
direction This property is required. string
Route Control direction.
vrf This property is required. string
VRF name.
device string
A device name from the provider configuration.
address This property is required. str
Peer address.
address_family This property is required. str
Address Family.
asn This property is required. str
Autonomous system number.
direction This property is required. str
Route Control direction.
vrf This property is required. str
VRF name.
device str
A device name from the provider configuration.
address This property is required. String
Peer address.
addressFamily This property is required. String
Address Family.
asn This property is required. String
Autonomous system number.
direction This property is required. String
Route Control direction.
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.

getBgpPeerAddressFamilyRouteControl Result

The following output properties are available:

Address string
Peer address.
AddressFamily string
Address Family.
Asn string
Autonomous system number.
Direction string
Route Control direction.
Id string
The distinguished name of the object.
RouteMapName string
Route Control Route-Map name.
Vrf string
VRF name.
Device string
A device name from the provider configuration.
Address string
Peer address.
AddressFamily string
Address Family.
Asn string
Autonomous system number.
Direction string
Route Control direction.
Id string
The distinguished name of the object.
RouteMapName string
Route Control Route-Map name.
Vrf string
VRF name.
Device string
A device name from the provider configuration.
address String
Peer address.
addressFamily String
Address Family.
asn String
Autonomous system number.
direction String
Route Control direction.
id String
The distinguished name of the object.
routeMapName String
Route Control Route-Map name.
vrf String
VRF name.
device String
A device name from the provider configuration.
address string
Peer address.
addressFamily string
Address Family.
asn string
Autonomous system number.
direction string
Route Control direction.
id string
The distinguished name of the object.
routeMapName string
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_name str
Route Control Route-Map name.
vrf str
VRF name.
device str
A device name from the provider configuration.
address String
Peer address.
addressFamily String
Address Family.
asn String
Autonomous system number.
direction String
Route Control direction.
id String
The distinguished name of the object.
routeMapName String
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 nxos Terraform Provider.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos