1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. BgpAddressFamilyIpv6Vrf
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.BgpAddressFamilyIpv6Vrf

Explore with Pulumi AI

This resource can manage the BGP Address Family IPv6 VRF configuration.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.BgpAddressFamilyIpv6Vrf;
import com.pulumi.iosxe.BgpAddressFamilyIpv6VrfArgs;
import com.pulumi.iosxe.inputs.BgpAddressFamilyIpv6VrfVrfArgs;
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 BgpAddressFamilyIpv6Vrf("example", BgpAddressFamilyIpv6VrfArgs.builder()        
            .afName("unicast")
            .asn("65000")
            .vrfs(BgpAddressFamilyIpv6VrfVrfArgs.builder()
                .ipv6_unicast_advertise_l2vpn_evpn(true)
                .ipv6_unicast_networks(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .ipv6_unicast_redistribute_connected(true)
                .ipv6_unicast_redistribute_static(true)
                .name("VRF1")
                .build())
            .build());

    }
}
Copy

Coming soon!

Coming soon!

resources:
  example:
    type: iosxe:BgpAddressFamilyIpv6Vrf
    properties:
      afName: unicast
      asn: '65000'
      vrfs:
        - ipv6_unicast_advertise_l2vpn_evpn: true
          ipv6_unicast_networks:
            - backdoor: true
              evpn: false
              network: 2001:1234::/64
              routeMap: RM1
          ipv6_unicast_redistribute_connected: true
          ipv6_unicast_redistribute_static: true
          name: VRF1
Copy

Create BgpAddressFamilyIpv6Vrf Resource

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

Constructor syntax

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

@overload
def BgpAddressFamilyIpv6Vrf(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            af_name: Optional[str] = None,
                            asn: Optional[str] = None,
                            delete_mode: Optional[str] = None,
                            device: Optional[str] = None,
                            vrfs: Optional[Sequence[BgpAddressFamilyIpv6VrfVrfArgs]] = None)
func NewBgpAddressFamilyIpv6Vrf(ctx *Context, name string, args BgpAddressFamilyIpv6VrfArgs, opts ...ResourceOption) (*BgpAddressFamilyIpv6Vrf, error)
public BgpAddressFamilyIpv6Vrf(string name, BgpAddressFamilyIpv6VrfArgs args, CustomResourceOptions? opts = null)
public BgpAddressFamilyIpv6Vrf(String name, BgpAddressFamilyIpv6VrfArgs args)
public BgpAddressFamilyIpv6Vrf(String name, BgpAddressFamilyIpv6VrfArgs args, CustomResourceOptions options)
type: iosxe:BgpAddressFamilyIpv6Vrf
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. BgpAddressFamilyIpv6VrfArgs
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. BgpAddressFamilyIpv6VrfArgs
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. BgpAddressFamilyIpv6VrfArgs
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. BgpAddressFamilyIpv6VrfArgs
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. BgpAddressFamilyIpv6VrfArgs
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 bgpAddressFamilyIpv6VrfResource = new Iosxe.BgpAddressFamilyIpv6Vrf("bgpAddressFamilyIpv6VrfResource", new()
{
    AfName = "string",
    Asn = "string",
    DeleteMode = "string",
    Device = "string",
    Vrfs = new[]
    {
        new Iosxe.Inputs.BgpAddressFamilyIpv6VrfVrfArgs
        {
            Name = "string",
            Ipv6UnicastAdvertiseL2vpnEvpn = false,
            Ipv6UnicastNetworks = new[]
            {
                new Iosxe.Inputs.BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetworkArgs
                {
                    Network = "string",
                    Backdoor = false,
                    Evpn = false,
                    RouteMap = "string",
                },
            },
            Ipv6UnicastRedistributeConnected = false,
            Ipv6UnicastRedistributeStatic = false,
        },
    },
});
Copy
example, err := iosxe.NewBgpAddressFamilyIpv6Vrf(ctx, "bgpAddressFamilyIpv6VrfResource", &iosxe.BgpAddressFamilyIpv6VrfArgs{
	AfName:     pulumi.String("string"),
	Asn:        pulumi.String("string"),
	DeleteMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Vrfs: iosxe.BgpAddressFamilyIpv6VrfVrfArray{
		&iosxe.BgpAddressFamilyIpv6VrfVrfArgs{
			Name:                          pulumi.String("string"),
			Ipv6UnicastAdvertiseL2vpnEvpn: pulumi.Bool(false),
			Ipv6UnicastNetworks: iosxe.BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetworkArray{
				&iosxe.BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetworkArgs{
					Network:  pulumi.String("string"),
					Backdoor: pulumi.Bool(false),
					Evpn:     pulumi.Bool(false),
					RouteMap: pulumi.String("string"),
				},
			},
			Ipv6UnicastRedistributeConnected: pulumi.Bool(false),
			Ipv6UnicastRedistributeStatic:    pulumi.Bool(false),
		},
	},
})
Copy
var bgpAddressFamilyIpv6VrfResource = new BgpAddressFamilyIpv6Vrf("bgpAddressFamilyIpv6VrfResource", BgpAddressFamilyIpv6VrfArgs.builder()
    .afName("string")
    .asn("string")
    .deleteMode("string")
    .device("string")
    .vrfs(BgpAddressFamilyIpv6VrfVrfArgs.builder()
        .name("string")
        .ipv6UnicastAdvertiseL2vpnEvpn(false)
        .ipv6UnicastNetworks(BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetworkArgs.builder()
            .network("string")
            .backdoor(false)
            .evpn(false)
            .routeMap("string")
            .build())
        .ipv6UnicastRedistributeConnected(false)
        .ipv6UnicastRedistributeStatic(false)
        .build())
    .build());
Copy
bgp_address_family_ipv6_vrf_resource = iosxe.BgpAddressFamilyIpv6Vrf("bgpAddressFamilyIpv6VrfResource",
    af_name="string",
    asn="string",
    delete_mode="string",
    device="string",
    vrfs=[{
        "name": "string",
        "ipv6_unicast_advertise_l2vpn_evpn": False,
        "ipv6_unicast_networks": [{
            "network": "string",
            "backdoor": False,
            "evpn": False,
            "route_map": "string",
        }],
        "ipv6_unicast_redistribute_connected": False,
        "ipv6_unicast_redistribute_static": False,
    }])
Copy
const bgpAddressFamilyIpv6VrfResource = new iosxe.BgpAddressFamilyIpv6Vrf("bgpAddressFamilyIpv6VrfResource", {
    afName: "string",
    asn: "string",
    deleteMode: "string",
    device: "string",
    vrfs: [{
        name: "string",
        ipv6UnicastAdvertiseL2vpnEvpn: false,
        ipv6UnicastNetworks: [{
            network: "string",
            backdoor: false,
            evpn: false,
            routeMap: "string",
        }],
        ipv6UnicastRedistributeConnected: false,
        ipv6UnicastRedistributeStatic: false,
    }],
});
Copy
type: iosxe:BgpAddressFamilyIpv6Vrf
properties:
    afName: string
    asn: string
    deleteMode: string
    device: string
    vrfs:
        - ipv6UnicastAdvertiseL2vpnEvpn: false
          ipv6UnicastNetworks:
            - backdoor: false
              evpn: false
              network: string
              routeMap: string
          ipv6UnicastRedistributeConnected: false
          ipv6UnicastRedistributeStatic: false
          name: string
Copy

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

AfName This property is required. string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
Asn This property is required. string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Vrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpAddressFamilyIpv6VrfVrf>
AfName This property is required. string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
Asn This property is required. string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Vrfs []BgpAddressFamilyIpv6VrfVrfArgs
afName This property is required. String
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn This property is required. String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
vrfs List<BgpAddressFamilyIpv6VrfVrf>
afName This property is required. string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn This property is required. string
deleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device string
A device name from the provider configuration.
vrfs BgpAddressFamilyIpv6VrfVrf[]
af_name This property is required. str
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn This property is required. str
delete_mode str
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device str
A device name from the provider configuration.
vrfs Sequence[BgpAddressFamilyIpv6VrfVrfArgs]
afName This property is required. String
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn This property is required. String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
vrfs List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the BgpAddressFamilyIpv6Vrf 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 BgpAddressFamilyIpv6Vrf Resource

Get an existing BgpAddressFamilyIpv6Vrf 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?: BgpAddressFamilyIpv6VrfState, opts?: CustomResourceOptions): BgpAddressFamilyIpv6Vrf
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        af_name: Optional[str] = None,
        asn: Optional[str] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        vrfs: Optional[Sequence[BgpAddressFamilyIpv6VrfVrfArgs]] = None) -> BgpAddressFamilyIpv6Vrf
func GetBgpAddressFamilyIpv6Vrf(ctx *Context, name string, id IDInput, state *BgpAddressFamilyIpv6VrfState, opts ...ResourceOption) (*BgpAddressFamilyIpv6Vrf, error)
public static BgpAddressFamilyIpv6Vrf Get(string name, Input<string> id, BgpAddressFamilyIpv6VrfState? state, CustomResourceOptions? opts = null)
public static BgpAddressFamilyIpv6Vrf get(String name, Output<String> id, BgpAddressFamilyIpv6VrfState state, CustomResourceOptions options)
resources:  _:    type: iosxe:BgpAddressFamilyIpv6Vrf    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:
AfName string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
Asn string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Vrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpAddressFamilyIpv6VrfVrf>
AfName string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
Asn string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Vrfs []BgpAddressFamilyIpv6VrfVrfArgs
afName String
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
vrfs List<BgpAddressFamilyIpv6VrfVrf>
afName string
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn string
deleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device string
A device name from the provider configuration.
vrfs BgpAddressFamilyIpv6VrfVrf[]
af_name str
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn str
delete_mode str
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device str
A device name from the provider configuration.
vrfs Sequence[BgpAddressFamilyIpv6VrfVrfArgs]
afName String
  • Choices: flowspec, mdt, multicast, mvpn, unicast
asn String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
vrfs List<Property Map>

Supporting Types

BgpAddressFamilyIpv6VrfVrf
, BgpAddressFamilyIpv6VrfVrfArgs

BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetwork
, BgpAddressFamilyIpv6VrfVrfIpv6UnicastNetworkArgs

Network This property is required. string
Backdoor bool
Evpn bool
RouteMap string
Network This property is required. string
Backdoor bool
Evpn bool
RouteMap string
network This property is required. String
backdoor Boolean
evpn Boolean
routeMap String
network This property is required. string
backdoor boolean
evpn boolean
routeMap string
network This property is required. str
backdoor bool
evpn bool
route_map str
network This property is required. String
backdoor Boolean
evpn Boolean
routeMap String

Import

 $ pulumi import iosxe:index/bgpAddressFamilyIpv6Vrf:BgpAddressFamilyIpv6Vrf example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/with-vrf/ipv6=unicast"
Copy

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

Package Details

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