1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. BgpPeerTemplateAddressFamily
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.BgpPeerTemplateAddressFamily

Explore with Pulumi AI

This resource can manage the BGP peer template address family configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.BgpPeerTemplateAddressFamily("example", new()
    {
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        Control = "nh-self,rr-client",
        SendCommunityExtended = "enabled",
        SendCommunityStandard = "enabled",
        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.NewBgpPeerTemplateAddressFamily(ctx, "example", &nxos.BgpPeerTemplateAddressFamilyArgs{
			AddressFamily:         pulumi.String("ipv4-ucast"),
			Asn:                   pulumi.String("65001"),
			Control:               pulumi.String("nh-self,rr-client"),
			SendCommunityExtended: pulumi.String("enabled"),
			SendCommunityStandard: pulumi.String("enabled"),
			TemplateName:          pulumi.String("SPINE-PEERS"),
		})
		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.BgpPeerTemplateAddressFamily;
import com.pulumi.nxos.BgpPeerTemplateAddressFamilyArgs;
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) {
        var example = new BgpPeerTemplateAddressFamily("example", BgpPeerTemplateAddressFamilyArgs.builder()        
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .control("nh-self,rr-client")
            .sendCommunityExtended("enabled")
            .sendCommunityStandard("enabled")
            .templateName("SPINE-PEERS")
            .build());

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

const example = new nxos.BgpPeerTemplateAddressFamily("example", {
    addressFamily: "ipv4-ucast",
    asn: "65001",
    control: "nh-self,rr-client",
    sendCommunityExtended: "enabled",
    sendCommunityStandard: "enabled",
    templateName: "SPINE-PEERS",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BgpPeerTemplateAddressFamily("example",
    address_family="ipv4-ucast",
    asn="65001",
    control="nh-self,rr-client",
    send_community_extended="enabled",
    send_community_standard="enabled",
    template_name="SPINE-PEERS")
Copy
resources:
  example:
    type: nxos:BgpPeerTemplateAddressFamily
    properties:
      addressFamily: ipv4-ucast
      asn: '65001'
      control: nh-self,rr-client
      sendCommunityExtended: enabled
      sendCommunityStandard: enabled
      templateName: SPINE-PEERS
Copy

Create BgpPeerTemplateAddressFamily Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BgpPeerTemplateAddressFamily(name: string, args: BgpPeerTemplateAddressFamilyArgs, opts?: CustomResourceOptions);
@overload
def BgpPeerTemplateAddressFamily(resource_name: str,
                                 args: BgpPeerTemplateAddressFamilyArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def BgpPeerTemplateAddressFamily(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 address_family: Optional[str] = None,
                                 asn: Optional[str] = None,
                                 template_name: Optional[str] = None,
                                 control: Optional[str] = None,
                                 device: Optional[str] = None,
                                 send_community_extended: Optional[str] = None,
                                 send_community_standard: Optional[str] = None)
func NewBgpPeerTemplateAddressFamily(ctx *Context, name string, args BgpPeerTemplateAddressFamilyArgs, opts ...ResourceOption) (*BgpPeerTemplateAddressFamily, error)
public BgpPeerTemplateAddressFamily(string name, BgpPeerTemplateAddressFamilyArgs args, CustomResourceOptions? opts = null)
public BgpPeerTemplateAddressFamily(String name, BgpPeerTemplateAddressFamilyArgs args)
public BgpPeerTemplateAddressFamily(String name, BgpPeerTemplateAddressFamilyArgs args, CustomResourceOptions options)
type: nxos:BgpPeerTemplateAddressFamily
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BgpPeerTemplateAddressFamilyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BgpPeerTemplateAddressFamilyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BgpPeerTemplateAddressFamilyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BgpPeerTemplateAddressFamilyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BgpPeerTemplateAddressFamilyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var bgpPeerTemplateAddressFamilyResource = new Nxos.BgpPeerTemplateAddressFamily("bgpPeerTemplateAddressFamilyResource", new()
{
    AddressFamily = "string",
    Asn = "string",
    TemplateName = "string",
    Control = "string",
    Device = "string",
    SendCommunityExtended = "string",
    SendCommunityStandard = "string",
});
Copy
example, err := nxos.NewBgpPeerTemplateAddressFamily(ctx, "bgpPeerTemplateAddressFamilyResource", &nxos.BgpPeerTemplateAddressFamilyArgs{
	AddressFamily:         pulumi.String("string"),
	Asn:                   pulumi.String("string"),
	TemplateName:          pulumi.String("string"),
	Control:               pulumi.String("string"),
	Device:                pulumi.String("string"),
	SendCommunityExtended: pulumi.String("string"),
	SendCommunityStandard: pulumi.String("string"),
})
Copy
var bgpPeerTemplateAddressFamilyResource = new BgpPeerTemplateAddressFamily("bgpPeerTemplateAddressFamilyResource", BgpPeerTemplateAddressFamilyArgs.builder()
    .addressFamily("string")
    .asn("string")
    .templateName("string")
    .control("string")
    .device("string")
    .sendCommunityExtended("string")
    .sendCommunityStandard("string")
    .build());
Copy
bgp_peer_template_address_family_resource = nxos.BgpPeerTemplateAddressFamily("bgpPeerTemplateAddressFamilyResource",
    address_family="string",
    asn="string",
    template_name="string",
    control="string",
    device="string",
    send_community_extended="string",
    send_community_standard="string")
Copy
const bgpPeerTemplateAddressFamilyResource = new nxos.BgpPeerTemplateAddressFamily("bgpPeerTemplateAddressFamilyResource", {
    addressFamily: "string",
    asn: "string",
    templateName: "string",
    control: "string",
    device: "string",
    sendCommunityExtended: "string",
    sendCommunityStandard: "string",
});
Copy
type: nxos:BgpPeerTemplateAddressFamily
properties:
    addressFamily: string
    asn: string
    control: string
    device: string
    sendCommunityExtended: string
    sendCommunityStandard: string
    templateName: string
Copy

BgpPeerTemplateAddressFamily Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BgpPeerTemplateAddressFamily resource accepts the following input properties:

AddressFamily This property is required. string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
Asn This property is required. string
Autonomous system number.
TemplateName This property is required. string
Peer template name.
Control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
Device string
A device name from the provider configuration.
SendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
SendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
AddressFamily This property is required. string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
Asn This property is required. string
Autonomous system number.
TemplateName This property is required. string
Peer template name.
Control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
Device string
A device name from the provider configuration.
SendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
SendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
addressFamily This property is required. String
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn This property is required. String
Autonomous system number.
templateName This property is required. String
Peer template name.
control String
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device String
A device name from the provider configuration.
sendCommunityExtended String
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard String
Send-community standard. - Choices: enabled, disabled - Default value: disabled
addressFamily This property is required. string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn This property is required. string
Autonomous system number.
templateName This property is required. string
Peer template name.
control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device string
A device name from the provider configuration.
sendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
address_family This property is required. str
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn This property is required. str
Autonomous system number.
template_name This property is required. str
Peer template name.
control str
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device str
A device name from the provider configuration.
send_community_extended str
Send-community extended. - Choices: enabled, disabled - Default value: disabled
send_community_standard str
Send-community standard. - Choices: enabled, disabled - Default value: disabled
addressFamily This property is required. String
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn This property is required. String
Autonomous system number.
templateName This property is required. String
Peer template name.
control String
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device String
A device name from the provider configuration.
sendCommunityExtended String
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard String
Send-community standard. - Choices: enabled, disabled - Default value: disabled

Outputs

All input properties are implicitly available as output properties. Additionally, the BgpPeerTemplateAddressFamily resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing BgpPeerTemplateAddressFamily Resource

Get an existing BgpPeerTemplateAddressFamily resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BgpPeerTemplateAddressFamilyState, opts?: CustomResourceOptions): BgpPeerTemplateAddressFamily
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        asn: Optional[str] = None,
        control: Optional[str] = None,
        device: Optional[str] = None,
        send_community_extended: Optional[str] = None,
        send_community_standard: Optional[str] = None,
        template_name: Optional[str] = None) -> BgpPeerTemplateAddressFamily
func GetBgpPeerTemplateAddressFamily(ctx *Context, name string, id IDInput, state *BgpPeerTemplateAddressFamilyState, opts ...ResourceOption) (*BgpPeerTemplateAddressFamily, error)
public static BgpPeerTemplateAddressFamily Get(string name, Input<string> id, BgpPeerTemplateAddressFamilyState? state, CustomResourceOptions? opts = null)
public static BgpPeerTemplateAddressFamily get(String name, Output<String> id, BgpPeerTemplateAddressFamilyState state, CustomResourceOptions options)
resources:  _:    type: nxos:BgpPeerTemplateAddressFamily    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AddressFamily string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
Asn string
Autonomous system number.
Control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
Device string
A device name from the provider configuration.
SendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
SendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
TemplateName string
Peer template name.
AddressFamily string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
Asn string
Autonomous system number.
Control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
Device string
A device name from the provider configuration.
SendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
SendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
TemplateName string
Peer template name.
addressFamily String
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn String
Autonomous system number.
control String
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device String
A device name from the provider configuration.
sendCommunityExtended String
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard String
Send-community standard. - Choices: enabled, disabled - Default value: disabled
templateName String
Peer template name.
addressFamily string
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn string
Autonomous system number.
control string
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device string
A device name from the provider configuration.
sendCommunityExtended string
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard string
Send-community standard. - Choices: enabled, disabled - Default value: disabled
templateName string
Peer template name.
address_family str
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn str
Autonomous system number.
control str
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device str
A device name from the provider configuration.
send_community_extended str
Send-community extended. - Choices: enabled, disabled - Default value: disabled
send_community_standard str
Send-community standard. - Choices: enabled, disabled - Default value: disabled
template_name str
Peer template name.
addressFamily String
Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
asn String
Autonomous system number.
control String
Peer address-family control. Choices: rr-client, nh-self, dis-peer-as-check, allow-self-as, default-originate, advertisement-interval, suppress-inactive, nh-self-all. Can be an empty string. Allowed formats: - Single value. Example: nh-self - Multiple values (comma-separated). Example: dis-peer-as-check,nh-self,rr-client,suppress-inactive. In this case values must be in alphabetical order.
device String
A device name from the provider configuration.
sendCommunityExtended String
Send-community extended. - Choices: enabled, disabled - Default value: disabled
sendCommunityStandard String
Send-community standard. - Choices: enabled, disabled - Default value: disabled
templateName String
Peer template name.

Import

 $ pulumi import nxos:index/bgpPeerTemplateAddressFamily:BgpPeerTemplateAddressFamily example "sys/bgp/inst/dom-[default]/peercont-[SPINE-PEERS]/af-[ipv4-ucast]"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
nxos lbrlabs/pulumi-nxos
License
Apache-2.0
Notes
This Pulumi package is based on the nxos Terraform Provider.