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

iosxe.BgpAddressFamilyIpv6

Explore with Pulumi AI

This resource can manage the BGP Address Family IPv6 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.BgpAddressFamilyIpv6;
import com.pulumi.iosxe.BgpAddressFamilyIpv6Args;
import com.pulumi.iosxe.inputs.BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs;
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 BgpAddressFamilyIpv6("example", BgpAddressFamilyIpv6Args.builder()        
            .afName("unicast")
            .asn("65000")
            .ipv6UnicastNetworks(BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs.builder()
                .backdoor(true)
                .network("2001:1234::/64")
                .route_map("RM1")
                .build())
            .ipv6UnicastRedistributeConnected(true)
            .ipv6UnicastRedistributeStatic(true)
            .build());

    }
}
Copy

Coming soon!

Coming soon!

resources:
  example:
    type: iosxe:BgpAddressFamilyIpv6
    properties:
      afName: unicast
      asn: '65000'
      ipv6UnicastNetworks:
        - backdoor: true
          network: 2001:1234::/64
          route_map: RM1
      ipv6UnicastRedistributeConnected: true
      ipv6UnicastRedistributeStatic: true
Copy

Create BgpAddressFamilyIpv6 Resource

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

Constructor syntax

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

@overload
def BgpAddressFamilyIpv6(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,
                         ipv6_unicast_networks: Optional[Sequence[BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs]] = None,
                         ipv6_unicast_redistribute_connected: Optional[bool] = None,
                         ipv6_unicast_redistribute_static: Optional[bool] = None)
func NewBgpAddressFamilyIpv6(ctx *Context, name string, args BgpAddressFamilyIpv6Args, opts ...ResourceOption) (*BgpAddressFamilyIpv6, error)
public BgpAddressFamilyIpv6(string name, BgpAddressFamilyIpv6Args args, CustomResourceOptions? opts = null)
public BgpAddressFamilyIpv6(String name, BgpAddressFamilyIpv6Args args)
public BgpAddressFamilyIpv6(String name, BgpAddressFamilyIpv6Args args, CustomResourceOptions options)
type: iosxe:BgpAddressFamilyIpv6
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. BgpAddressFamilyIpv6Args
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. BgpAddressFamilyIpv6Args
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. BgpAddressFamilyIpv6Args
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. BgpAddressFamilyIpv6Args
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. BgpAddressFamilyIpv6Args
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 bgpAddressFamilyIpv6Resource = new Iosxe.BgpAddressFamilyIpv6("bgpAddressFamilyIpv6Resource", new()
{
    AfName = "string",
    Asn = "string",
    DeleteMode = "string",
    Device = "string",
    Ipv6UnicastNetworks = new[]
    {
        new Iosxe.Inputs.BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs
        {
            Network = "string",
            Backdoor = false,
            RouteMap = "string",
        },
    },
    Ipv6UnicastRedistributeConnected = false,
    Ipv6UnicastRedistributeStatic = false,
});
Copy
example, err := iosxe.NewBgpAddressFamilyIpv6(ctx, "bgpAddressFamilyIpv6Resource", &iosxe.BgpAddressFamilyIpv6Args{
	AfName:     pulumi.String("string"),
	Asn:        pulumi.String("string"),
	DeleteMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Ipv6UnicastNetworks: iosxe.BgpAddressFamilyIpv6Ipv6UnicastNetworkArray{
		&iosxe.BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs{
			Network:  pulumi.String("string"),
			Backdoor: pulumi.Bool(false),
			RouteMap: pulumi.String("string"),
		},
	},
	Ipv6UnicastRedistributeConnected: pulumi.Bool(false),
	Ipv6UnicastRedistributeStatic:    pulumi.Bool(false),
})
Copy
var bgpAddressFamilyIpv6Resource = new BgpAddressFamilyIpv6("bgpAddressFamilyIpv6Resource", BgpAddressFamilyIpv6Args.builder()
    .afName("string")
    .asn("string")
    .deleteMode("string")
    .device("string")
    .ipv6UnicastNetworks(BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs.builder()
        .network("string")
        .backdoor(false)
        .routeMap("string")
        .build())
    .ipv6UnicastRedistributeConnected(false)
    .ipv6UnicastRedistributeStatic(false)
    .build());
Copy
bgp_address_family_ipv6_resource = iosxe.BgpAddressFamilyIpv6("bgpAddressFamilyIpv6Resource",
    af_name="string",
    asn="string",
    delete_mode="string",
    device="string",
    ipv6_unicast_networks=[{
        "network": "string",
        "backdoor": False,
        "route_map": "string",
    }],
    ipv6_unicast_redistribute_connected=False,
    ipv6_unicast_redistribute_static=False)
Copy
const bgpAddressFamilyIpv6Resource = new iosxe.BgpAddressFamilyIpv6("bgpAddressFamilyIpv6Resource", {
    afName: "string",
    asn: "string",
    deleteMode: "string",
    device: "string",
    ipv6UnicastNetworks: [{
        network: "string",
        backdoor: false,
        routeMap: "string",
    }],
    ipv6UnicastRedistributeConnected: false,
    ipv6UnicastRedistributeStatic: false,
});
Copy
type: iosxe:BgpAddressFamilyIpv6
properties:
    afName: string
    asn: string
    deleteMode: string
    device: string
    ipv6UnicastNetworks:
        - backdoor: false
          network: string
          routeMap: string
    ipv6UnicastRedistributeConnected: false
    ipv6UnicastRedistributeStatic: false
Copy

BgpAddressFamilyIpv6 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 BgpAddressFamilyIpv6 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.
Ipv6UnicastNetworks List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpAddressFamilyIpv6Ipv6UnicastNetwork>
Specify a network to announce via BGP
Ipv6UnicastRedistributeConnected bool
Connected
Ipv6UnicastRedistributeStatic bool
Static routes
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.
Ipv6UnicastNetworks []BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs
Specify a network to announce via BGP
Ipv6UnicastRedistributeConnected bool
Connected
Ipv6UnicastRedistributeStatic bool
Static routes
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.
ipv6UnicastNetworks List<BgpAddressFamilyIpv6Ipv6UnicastNetwork>
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected Boolean
Connected
ipv6UnicastRedistributeStatic Boolean
Static routes
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.
ipv6UnicastNetworks BgpAddressFamilyIpv6Ipv6UnicastNetwork[]
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected boolean
Connected
ipv6UnicastRedistributeStatic boolean
Static routes
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.
ipv6_unicast_networks Sequence[BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs]
Specify a network to announce via BGP
ipv6_unicast_redistribute_connected bool
Connected
ipv6_unicast_redistribute_static bool
Static routes
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.
ipv6UnicastNetworks List<Property Map>
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected Boolean
Connected
ipv6UnicastRedistributeStatic Boolean
Static routes

Outputs

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

Get an existing BgpAddressFamilyIpv6 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?: BgpAddressFamilyIpv6State, opts?: CustomResourceOptions): BgpAddressFamilyIpv6
@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,
        ipv6_unicast_networks: Optional[Sequence[BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs]] = None,
        ipv6_unicast_redistribute_connected: Optional[bool] = None,
        ipv6_unicast_redistribute_static: Optional[bool] = None) -> BgpAddressFamilyIpv6
func GetBgpAddressFamilyIpv6(ctx *Context, name string, id IDInput, state *BgpAddressFamilyIpv6State, opts ...ResourceOption) (*BgpAddressFamilyIpv6, error)
public static BgpAddressFamilyIpv6 Get(string name, Input<string> id, BgpAddressFamilyIpv6State? state, CustomResourceOptions? opts = null)
public static BgpAddressFamilyIpv6 get(String name, Output<String> id, BgpAddressFamilyIpv6State state, CustomResourceOptions options)
resources:  _:    type: iosxe:BgpAddressFamilyIpv6    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.
Ipv6UnicastNetworks List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpAddressFamilyIpv6Ipv6UnicastNetwork>
Specify a network to announce via BGP
Ipv6UnicastRedistributeConnected bool
Connected
Ipv6UnicastRedistributeStatic bool
Static routes
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.
Ipv6UnicastNetworks []BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs
Specify a network to announce via BGP
Ipv6UnicastRedistributeConnected bool
Connected
Ipv6UnicastRedistributeStatic bool
Static routes
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.
ipv6UnicastNetworks List<BgpAddressFamilyIpv6Ipv6UnicastNetwork>
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected Boolean
Connected
ipv6UnicastRedistributeStatic Boolean
Static routes
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.
ipv6UnicastNetworks BgpAddressFamilyIpv6Ipv6UnicastNetwork[]
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected boolean
Connected
ipv6UnicastRedistributeStatic boolean
Static routes
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.
ipv6_unicast_networks Sequence[BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs]
Specify a network to announce via BGP
ipv6_unicast_redistribute_connected bool
Connected
ipv6_unicast_redistribute_static bool
Static routes
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.
ipv6UnicastNetworks List<Property Map>
Specify a network to announce via BGP
ipv6UnicastRedistributeConnected Boolean
Connected
ipv6UnicastRedistributeStatic Boolean
Static routes

Supporting Types

BgpAddressFamilyIpv6Ipv6UnicastNetwork
, BgpAddressFamilyIpv6Ipv6UnicastNetworkArgs

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

Import

 $ pulumi import iosxe:index/bgpAddressFamilyIpv6:BgpAddressFamilyIpv6 example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/no-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.