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

nxos.getBgpPeerTemplateMaxPrefix

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 template Maximum Prefix Policy configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Pulumi.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpPeerTemplateMaxPrefix.Invoke(new()
    {
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        TemplateName = "SPINE-PEERS",
    });

});
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.LookupBgpPeerTemplateMaxPrefix(ctx, &nxos.LookupBgpPeerTemplateMaxPrefixArgs{
			AddressFamily: "ipv4-ucast",
			Asn:           "65001",
			TemplateName:  "SPINE-PEERS",
		}, 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.GetBgpPeerTemplateMaxPrefixArgs;
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.getBgpPeerTemplateMaxPrefix(GetBgpPeerTemplateMaxPrefixArgs.builder()
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .templateName("SPINE-PEERS")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";

const example = nxos.getBgpPeerTemplateMaxPrefix({
    addressFamily: "ipv4-ucast",
    asn: "65001",
    templateName: "SPINE-PEERS",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp_peer_template_max_prefix(address_family="ipv4-ucast",
    asn="65001",
    template_name="SPINE-PEERS")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getBgpPeerTemplateMaxPrefix
      Arguments:
        addressFamily: ipv4-ucast
        asn: '65001'
        templateName: SPINE-PEERS
Copy

Using getBgpPeerTemplateMaxPrefix

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 getBgpPeerTemplateMaxPrefix(args: GetBgpPeerTemplateMaxPrefixArgs, opts?: InvokeOptions): Promise<GetBgpPeerTemplateMaxPrefixResult>
function getBgpPeerTemplateMaxPrefixOutput(args: GetBgpPeerTemplateMaxPrefixOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerTemplateMaxPrefixResult>
Copy
def get_bgp_peer_template_max_prefix(address_family: Optional[str] = None,
                                     asn: Optional[str] = None,
                                     device: Optional[str] = None,
                                     template_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetBgpPeerTemplateMaxPrefixResult
def get_bgp_peer_template_max_prefix_output(address_family: Optional[pulumi.Input[str]] = None,
                                     asn: Optional[pulumi.Input[str]] = None,
                                     device: Optional[pulumi.Input[str]] = None,
                                     template_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerTemplateMaxPrefixResult]
Copy
func LookupBgpPeerTemplateMaxPrefix(ctx *Context, args *LookupBgpPeerTemplateMaxPrefixArgs, opts ...InvokeOption) (*LookupBgpPeerTemplateMaxPrefixResult, error)
func LookupBgpPeerTemplateMaxPrefixOutput(ctx *Context, args *LookupBgpPeerTemplateMaxPrefixOutputArgs, opts ...InvokeOption) LookupBgpPeerTemplateMaxPrefixResultOutput
Copy

> Note: This function is named LookupBgpPeerTemplateMaxPrefix in the Go SDK.

public static class GetBgpPeerTemplateMaxPrefix 
{
    public static Task<GetBgpPeerTemplateMaxPrefixResult> InvokeAsync(GetBgpPeerTemplateMaxPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpPeerTemplateMaxPrefixResult> Invoke(GetBgpPeerTemplateMaxPrefixInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBgpPeerTemplateMaxPrefixResult> getBgpPeerTemplateMaxPrefix(GetBgpPeerTemplateMaxPrefixArgs args, InvokeOptions options)
public static Output<GetBgpPeerTemplateMaxPrefixResult> getBgpPeerTemplateMaxPrefix(GetBgpPeerTemplateMaxPrefixArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getBgpPeerTemplateMaxPrefix:getBgpPeerTemplateMaxPrefix
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AddressFamily This property is required. string
Address Family.
Asn This property is required. string
Autonomous system number.
TemplateName This property is required. string
Peer template name.
Device string
A device name from the provider configuration.
AddressFamily This property is required. string
Address Family.
Asn This property is required. string
Autonomous system number.
TemplateName This property is required. string
Peer template name.
Device string
A device name from the provider configuration.
addressFamily This property is required. String
Address Family.
asn This property is required. String
Autonomous system number.
templateName This property is required. String
Peer template name.
device String
A device name from the provider configuration.
addressFamily This property is required. string
Address Family.
asn This property is required. string
Autonomous system number.
templateName This property is required. string
Peer template name.
device string
A device name from the provider configuration.
address_family This property is required. str
Address Family.
asn This property is required. str
Autonomous system number.
template_name This property is required. str
Peer template name.
device str
A device name from the provider configuration.
addressFamily This property is required. String
Address Family.
asn This property is required. String
Autonomous system number.
templateName This property is required. String
Peer template name.
device String
A device name from the provider configuration.

getBgpPeerTemplateMaxPrefix Result

The following output properties are available:

Action string
Action to do when limit is exceeded.
AddressFamily string
Address Family.
Asn string
Autonomous system number.
Id string
The distinguished name of the object.
MaximumPrefix int
Maximum number of prefixes allowed from the peer.
RestartTime int
The period of time in minutes before restarting the peer when the prefix limit is reached.
TemplateName string
Peer template name.
Threshold int
The period of time in minutes before restarting the peer when the prefix limit is reached.
Device string
A device name from the provider configuration.
Action string
Action to do when limit is exceeded.
AddressFamily string
Address Family.
Asn string
Autonomous system number.
Id string
The distinguished name of the object.
MaximumPrefix int
Maximum number of prefixes allowed from the peer.
RestartTime int
The period of time in minutes before restarting the peer when the prefix limit is reached.
TemplateName string
Peer template name.
Threshold int
The period of time in minutes before restarting the peer when the prefix limit is reached.
Device string
A device name from the provider configuration.
action String
Action to do when limit is exceeded.
addressFamily String
Address Family.
asn String
Autonomous system number.
id String
The distinguished name of the object.
maximumPrefix Integer
Maximum number of prefixes allowed from the peer.
restartTime Integer
The period of time in minutes before restarting the peer when the prefix limit is reached.
templateName String
Peer template name.
threshold Integer
The period of time in minutes before restarting the peer when the prefix limit is reached.
device String
A device name from the provider configuration.
action string
Action to do when limit is exceeded.
addressFamily string
Address Family.
asn string
Autonomous system number.
id string
The distinguished name of the object.
maximumPrefix number
Maximum number of prefixes allowed from the peer.
restartTime number
The period of time in minutes before restarting the peer when the prefix limit is reached.
templateName string
Peer template name.
threshold number
The period of time in minutes before restarting the peer when the prefix limit is reached.
device string
A device name from the provider configuration.
action str
Action to do when limit is exceeded.
address_family str
Address Family.
asn str
Autonomous system number.
id str
The distinguished name of the object.
maximum_prefix int
Maximum number of prefixes allowed from the peer.
restart_time int
The period of time in minutes before restarting the peer when the prefix limit is reached.
template_name str
Peer template name.
threshold int
The period of time in minutes before restarting the peer when the prefix limit is reached.
device str
A device name from the provider configuration.
action String
Action to do when limit is exceeded.
addressFamily String
Address Family.
asn String
Autonomous system number.
id String
The distinguished name of the object.
maximumPrefix Number
Maximum number of prefixes allowed from the peer.
restartTime Number
The period of time in minutes before restarting the peer when the prefix limit is reached.
templateName String
Peer template name.
threshold Number
The period of time in minutes before restarting the peer when the prefix limit is reached.
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