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

nxos.BgpPeerAddressFamily

Explore with Pulumi AI

This resource can manage the BGP peer 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.BgpPeerAddressFamily("example", new()
    {
        Address = "192.168.0.1",
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        Control = "nh-self,rr-client",
        SendCommunityExtended = "enabled",
        SendCommunityStandard = "enabled",
        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.NewBgpPeerAddressFamily(ctx, "example", &nxos.BgpPeerAddressFamilyArgs{
			Address:               pulumi.String("192.168.0.1"),
			AddressFamily:         pulumi.String("ipv4-ucast"),
			Asn:                   pulumi.String("65001"),
			Control:               pulumi.String("nh-self,rr-client"),
			SendCommunityExtended: pulumi.String("enabled"),
			SendCommunityStandard: pulumi.String("enabled"),
			Vrf:                   pulumi.String("default"),
		})
		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.BgpPeerAddressFamily;
import com.pulumi.nxos.BgpPeerAddressFamilyArgs;
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 BgpPeerAddressFamily("example", BgpPeerAddressFamilyArgs.builder()        
            .address("192.168.0.1")
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .control("nh-self,rr-client")
            .sendCommunityExtended("enabled")
            .sendCommunityStandard("enabled")
            .vrf("default")
            .build());

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

const example = new nxos.BgpPeerAddressFamily("example", {
    address: "192.168.0.1",
    addressFamily: "ipv4-ucast",
    asn: "65001",
    control: "nh-self,rr-client",
    sendCommunityExtended: "enabled",
    sendCommunityStandard: "enabled",
    vrf: "default",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BgpPeerAddressFamily("example",
    address="192.168.0.1",
    address_family="ipv4-ucast",
    asn="65001",
    control="nh-self,rr-client",
    send_community_extended="enabled",
    send_community_standard="enabled",
    vrf="default")
Copy
resources:
  example:
    type: nxos:BgpPeerAddressFamily
    properties:
      address: 192.168.0.1
      addressFamily: ipv4-ucast
      asn: '65001'
      control: nh-self,rr-client
      sendCommunityExtended: enabled
      sendCommunityStandard: enabled
      vrf: default
Copy

Create BgpPeerAddressFamily Resource

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

Constructor syntax

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

@overload
def BgpPeerAddressFamily(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address: Optional[str] = None,
                         address_family: Optional[str] = None,
                         asn: Optional[str] = None,
                         vrf: Optional[str] = None,
                         control: Optional[str] = None,
                         device: Optional[str] = None,
                         send_community_extended: Optional[str] = None,
                         send_community_standard: Optional[str] = None)
func NewBgpPeerAddressFamily(ctx *Context, name string, args BgpPeerAddressFamilyArgs, opts ...ResourceOption) (*BgpPeerAddressFamily, error)
public BgpPeerAddressFamily(string name, BgpPeerAddressFamilyArgs args, CustomResourceOptions? opts = null)
public BgpPeerAddressFamily(String name, BgpPeerAddressFamilyArgs args)
public BgpPeerAddressFamily(String name, BgpPeerAddressFamilyArgs args, CustomResourceOptions options)
type: nxos:BgpPeerAddressFamily
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. BgpPeerAddressFamilyArgs
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. BgpPeerAddressFamilyArgs
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. BgpPeerAddressFamilyArgs
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. BgpPeerAddressFamilyArgs
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. BgpPeerAddressFamilyArgs
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 bgpPeerAddressFamilyResource = new Nxos.BgpPeerAddressFamily("bgpPeerAddressFamilyResource", new()
{
    Address = "string",
    AddressFamily = "string",
    Asn = "string",
    Vrf = "string",
    Control = "string",
    Device = "string",
    SendCommunityExtended = "string",
    SendCommunityStandard = "string",
});
Copy
example, err := nxos.NewBgpPeerAddressFamily(ctx, "bgpPeerAddressFamilyResource", &nxos.BgpPeerAddressFamilyArgs{
	Address:               pulumi.String("string"),
	AddressFamily:         pulumi.String("string"),
	Asn:                   pulumi.String("string"),
	Vrf:                   pulumi.String("string"),
	Control:               pulumi.String("string"),
	Device:                pulumi.String("string"),
	SendCommunityExtended: pulumi.String("string"),
	SendCommunityStandard: pulumi.String("string"),
})
Copy
var bgpPeerAddressFamilyResource = new BgpPeerAddressFamily("bgpPeerAddressFamilyResource", BgpPeerAddressFamilyArgs.builder()
    .address("string")
    .addressFamily("string")
    .asn("string")
    .vrf("string")
    .control("string")
    .device("string")
    .sendCommunityExtended("string")
    .sendCommunityStandard("string")
    .build());
Copy
bgp_peer_address_family_resource = nxos.BgpPeerAddressFamily("bgpPeerAddressFamilyResource",
    address="string",
    address_family="string",
    asn="string",
    vrf="string",
    control="string",
    device="string",
    send_community_extended="string",
    send_community_standard="string")
Copy
const bgpPeerAddressFamilyResource = new nxos.BgpPeerAddressFamily("bgpPeerAddressFamilyResource", {
    address: "string",
    addressFamily: "string",
    asn: "string",
    vrf: "string",
    control: "string",
    device: "string",
    sendCommunityExtended: "string",
    sendCommunityStandard: "string",
});
Copy
type: nxos:BgpPeerAddressFamily
properties:
    address: string
    addressFamily: string
    asn: string
    control: string
    device: string
    sendCommunityExtended: string
    sendCommunityStandard: string
    vrf: string
Copy

BgpPeerAddressFamily 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 BgpPeerAddressFamily resource accepts the following input properties:

Address This property is required. string
Peer address.
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.
Vrf This property is required. string
VRF 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 This property is required. string
Peer address.
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.
Vrf This property is required. string
VRF 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 This property is required. String
Peer address.
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.
vrf This property is required. String
VRF 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 This property is required. string
Peer address.
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.
vrf This property is required. string
VRF 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 This property is required. str
Peer address.
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.
vrf This property is required. str
VRF 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
address This property is required. String
Peer address.
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.
vrf This property is required. String
VRF 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 BgpPeerAddressFamily 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 BgpPeerAddressFamily Resource

Get an existing BgpPeerAddressFamily 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?: BgpPeerAddressFamilyState, opts?: CustomResourceOptions): BgpPeerAddressFamily
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = 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,
        vrf: Optional[str] = None) -> BgpPeerAddressFamily
func GetBgpPeerAddressFamily(ctx *Context, name string, id IDInput, state *BgpPeerAddressFamilyState, opts ...ResourceOption) (*BgpPeerAddressFamily, error)
public static BgpPeerAddressFamily Get(string name, Input<string> id, BgpPeerAddressFamilyState? state, CustomResourceOptions? opts = null)
public static BgpPeerAddressFamily get(String name, Output<String> id, BgpPeerAddressFamilyState state, CustomResourceOptions options)
resources:  _:    type: nxos:BgpPeerAddressFamily    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:
Address string
Peer address.
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
Vrf string
VRF name.
Address string
Peer address.
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
Vrf string
VRF name.
address String
Peer address.
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
vrf String
VRF name.
address string
Peer address.
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
vrf string
VRF name.
address str
Peer address.
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
vrf str
VRF name.
address String
Peer address.
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
vrf String
VRF name.

Import

 $ pulumi import nxos:index/bgpPeerAddressFamily:BgpPeerAddressFamily example "sys/bgp/inst/dom-[default]/peer-[192.168.0.1]/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.