Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
nxos.getBgpPeerTemplate
Explore with Pulumi AI
This data source can read the BGP peer template configuration.
- API Documentation: bgpPeerCont
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Pulumi.Nxos;
return await Deployment.RunAsync(() =>
{
var example = Nxos.GetBgpPeerTemplate.Invoke(new()
{
Asn = "65001",
TemplateName = "SPINE-PEERS",
});
});
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.LookupBgpPeerTemplate(ctx, &nxos.LookupBgpPeerTemplateArgs{
Asn: "65001",
TemplateName: "SPINE-PEERS",
}, 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.GetBgpPeerTemplateArgs;
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.getBgpPeerTemplate(GetBgpPeerTemplateArgs.builder()
.asn("65001")
.templateName("SPINE-PEERS")
.build());
}
}
import pulumi
import pulumi_nxos as nxos
example = nxos.get_bgp_peer_template(asn="65001",
template_name="SPINE-PEERS")
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";
const example = nxos.getBgpPeerTemplate({
asn: "65001",
templateName: "SPINE-PEERS",
});
variables:
example:
fn::invoke:
Function: nxos:getBgpPeerTemplate
Arguments:
asn: '65001'
templateName: SPINE-PEERS
Using getBgpPeerTemplate
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 getBgpPeerTemplate(args: GetBgpPeerTemplateArgs, opts?: InvokeOptions): Promise<GetBgpPeerTemplateResult>
function getBgpPeerTemplateOutput(args: GetBgpPeerTemplateOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerTemplateResult>
def get_bgp_peer_template(asn: Optional[str] = None,
device: Optional[str] = None,
template_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBgpPeerTemplateResult
def get_bgp_peer_template_output(asn: Optional[pulumi.Input[str]] = None,
device: Optional[pulumi.Input[str]] = None,
template_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerTemplateResult]
func LookupBgpPeerTemplate(ctx *Context, args *LookupBgpPeerTemplateArgs, opts ...InvokeOption) (*LookupBgpPeerTemplateResult, error)
func LookupBgpPeerTemplateOutput(ctx *Context, args *LookupBgpPeerTemplateOutputArgs, opts ...InvokeOption) LookupBgpPeerTemplateResultOutput
> Note: This function is named LookupBgpPeerTemplate
in the Go SDK.
public static class GetBgpPeerTemplate
{
public static Task<GetBgpPeerTemplateResult> InvokeAsync(GetBgpPeerTemplateArgs args, InvokeOptions? opts = null)
public static Output<GetBgpPeerTemplateResult> Invoke(GetBgpPeerTemplateInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBgpPeerTemplateResult> getBgpPeerTemplate(GetBgpPeerTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: nxos:index/getBgpPeerTemplate:getBgpPeerTemplate
arguments:
# arguments dictionary
The following arguments are supported:
- Asn string
- Autonomous system number.
- Template
Name string - Peer template name.
- Device string
- A device name from the provider configuration.
- Asn string
- Autonomous system number.
- Template
Name string - Peer template name.
- Device string
- A device name from the provider configuration.
- asn String
- Autonomous system number.
- template
Name String - Peer template name.
- device String
- A device name from the provider configuration.
- asn string
- Autonomous system number.
- template
Name string - Peer template name.
- device string
- A device name from the provider configuration.
- asn str
- Autonomous system number.
- template_
name str - Peer template name.
- device str
- A device name from the provider configuration.
- asn String
- Autonomous system number.
- template
Name String - Peer template name.
- device String
- A device name from the provider configuration.
getBgpPeerTemplate Result
The following output properties are available:
- Asn string
- Autonomous system number.
- Description string
- Peer template description.
- Id string
- The distinguished name of the object.
- Peer
Type string - Neighbor Fabric Type.
- Remote
Asn string - Peer template autonomous system number.
- Source
Interface string - Source Interface. Must match first field in the output of
show intf brief
. - Template
Name string - Peer template name.
- Device string
- A device name from the provider configuration.
- Asn string
- Autonomous system number.
- Description string
- Peer template description.
- Id string
- The distinguished name of the object.
- Peer
Type string - Neighbor Fabric Type.
- Remote
Asn string - Peer template autonomous system number.
- Source
Interface string - Source Interface. Must match first field in the output of
show intf brief
. - Template
Name string - Peer template name.
- Device string
- A device name from the provider configuration.
- asn String
- Autonomous system number.
- description String
- Peer template description.
- id String
- The distinguished name of the object.
- peer
Type String - Neighbor Fabric Type.
- remote
Asn String - Peer template autonomous system number.
- source
Interface String - Source Interface. Must match first field in the output of
show intf brief
. - template
Name String - Peer template name.
- device String
- A device name from the provider configuration.
- asn string
- Autonomous system number.
- description string
- Peer template description.
- id string
- The distinguished name of the object.
- peer
Type string - Neighbor Fabric Type.
- remote
Asn string - Peer template autonomous system number.
- source
Interface string - Source Interface. Must match first field in the output of
show intf brief
. - template
Name string - Peer template name.
- device string
- A device name from the provider configuration.
- asn str
- Autonomous system number.
- description str
- Peer template description.
- id str
- The distinguished name of the object.
- peer_
type str - Neighbor Fabric Type.
- remote_
asn str - Peer template autonomous system number.
- source_
interface str - Source Interface. Must match first field in the output of
show intf brief
. - template_
name str - Peer template name.
- device str
- A device name from the provider configuration.
- asn String
- Autonomous system number.
- description String
- Peer template description.
- id String
- The distinguished name of the object.
- peer
Type String - Neighbor Fabric Type.
- remote
Asn String - Peer template autonomous system number.
- source
Interface String - Source Interface. Must match first field in the output of
show intf brief
. - template
Name String - Peer template 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.