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

iosxe.BgpAddressFamilyIpv4Vrf

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

    This resource can manage the BGP Address Family IPv4 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.BgpAddressFamilyIpv4Vrf;
import com.pulumi.iosxe.BgpAddressFamilyIpv4VrfArgs;
import com.pulumi.iosxe.inputs.BgpAddressFamilyIpv4VrfVrfArgs;
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 BgpAddressFamilyIpv4Vrf("example", BgpAddressFamilyIpv4VrfArgs.builder()        
            .afName("unicast")
            .asn("65000")
            .vrfs(BgpAddressFamilyIpv4VrfVrfArgs.builder()
                .ipv4_unicast_advertise_l2vpn_evpn(true)
                .ipv4_unicast_networks(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .ipv4_unicast_networks_mask(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .ipv4_unicast_redistribute_connected(true)
                .ipv4_unicast_redistribute_static(true)
                .name("VRF1")
                .build())
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  example:
    type: iosxe:BgpAddressFamilyIpv4Vrf
    properties:
      afName: unicast
      asn: '65000'
      vrfs:
        - ipv4_unicast_advertise_l2vpn_evpn: true
          ipv4_unicast_networks:
            - backdoor: true
              network: 13.0.0.0
              routeMap: RM1
          ipv4_unicast_networks_mask:
            - backdoor: true
              mask: 255.255.0.0
              network: 12.0.0.0
              routeMap: RM1
          ipv4_unicast_redistribute_connected: true
          ipv4_unicast_redistribute_static: true
          name: VRF1

    Create BgpAddressFamilyIpv4Vrf Resource

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

    Constructor syntax

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

@overload
def BgpAddressFamilyIpv4Vrf(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[BgpAddressFamilyIpv4VrfVrfArgs]] = None)
    func NewBgpAddressFamilyIpv4Vrf(ctx *Context, name string, args BgpAddressFamilyIpv4VrfArgs, opts ...ResourceOption) (*BgpAddressFamilyIpv4Vrf, error)
    public BgpAddressFamilyIpv4Vrf(string name, BgpAddressFamilyIpv4VrfArgs args, CustomResourceOptions? opts = null)
    public BgpAddressFamilyIpv4Vrf(String name, BgpAddressFamilyIpv4VrfArgs args)
public BgpAddressFamilyIpv4Vrf(String name, BgpAddressFamilyIpv4VrfArgs args, CustomResourceOptions options)

    type: iosxe:BgpAddressFamilyIpv4Vrf
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Example

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

    var bgpAddressFamilyIpv4VrfResource = new Iosxe.BgpAddressFamilyIpv4Vrf("bgpAddressFamilyIpv4VrfResource", new()
{
    AfName = "string",
    Asn = "string",
    DeleteMode = "string",
    Device = "string",
    Vrfs = new[]
    {
        new Iosxe.Inputs.BgpAddressFamilyIpv4VrfVrfArgs
        {
            Name = "string",
            Ipv4UnicastAdvertiseL2vpnEvpn = false,
            Ipv4UnicastNetworks = new[]
            {
                new Iosxe.Inputs.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArgs
                {
                    Network = "string",
                    Backdoor = false,
                    Evpn = false,
                    RouteMap = "string",
                },
            },
            Ipv4UnicastNetworksMasks = new[]
            {
                new Iosxe.Inputs.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArgs
                {
                    Mask = "string",
                    Network = "string",
                    Backdoor = false,
                    Evpn = false,
                    RouteMap = "string",
                },
            },
            Ipv4UnicastRedistributeConnected = false,
            Ipv4UnicastRedistributeStatic = false,
        },
    },
});

    example, err := iosxe.NewBgpAddressFamilyIpv4Vrf(ctx, "bgpAddressFamilyIpv4VrfResource", &iosxe.BgpAddressFamilyIpv4VrfArgs{
	AfName:     pulumi.String("string"),
	Asn:        pulumi.String("string"),
	DeleteMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Vrfs: iosxe.BgpAddressFamilyIpv4VrfVrfArray{
		&iosxe.BgpAddressFamilyIpv4VrfVrfArgs{
			Name:                          pulumi.String("string"),
			Ipv4UnicastAdvertiseL2vpnEvpn: pulumi.Bool(false),
			Ipv4UnicastNetworks: iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArray{
				&iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArgs{
					Network:  pulumi.String("string"),
					Backdoor: pulumi.Bool(false),
					Evpn:     pulumi.Bool(false),
					RouteMap: pulumi.String("string"),
				},
			},
			Ipv4UnicastNetworksMasks: iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArray{
				&iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArgs{
					Mask:     pulumi.String("string"),
					Network:  pulumi.String("string"),
					Backdoor: pulumi.Bool(false),
					Evpn:     pulumi.Bool(false),
					RouteMap: pulumi.String("string"),
				},
			},
			Ipv4UnicastRedistributeConnected: pulumi.Bool(false),
			Ipv4UnicastRedistributeStatic:    pulumi.Bool(false),
		},
	},
})

    var bgpAddressFamilyIpv4VrfResource = new BgpAddressFamilyIpv4Vrf("bgpAddressFamilyIpv4VrfResource", BgpAddressFamilyIpv4VrfArgs.builder()
    .afName("string")
    .asn("string")
    .deleteMode("string")
    .device("string")
    .vrfs(BgpAddressFamilyIpv4VrfVrfArgs.builder()
        .name("string")
        .ipv4UnicastAdvertiseL2vpnEvpn(false)
        .ipv4UnicastNetworks(BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArgs.builder()
            .network("string")
            .backdoor(false)
            .evpn(false)
            .routeMap("string")
            .build())
        .ipv4UnicastNetworksMasks(BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArgs.builder()
            .mask("string")
            .network("string")
            .backdoor(false)
            .evpn(false)
            .routeMap("string")
            .build())
        .ipv4UnicastRedistributeConnected(false)
        .ipv4UnicastRedistributeStatic(false)
        .build())
    .build());

    bgp_address_family_ipv4_vrf_resource = iosxe.BgpAddressFamilyIpv4Vrf("bgpAddressFamilyIpv4VrfResource",
    af_name="string",
    asn="string",
    delete_mode="string",
    device="string",
    vrfs=[iosxe.BgpAddressFamilyIpv4VrfVrfArgs(
        name="string",
        ipv4_unicast_advertise_l2vpn_evpn=False,
        ipv4_unicast_networks=[iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArgs(
            network="string",
            backdoor=False,
            evpn=False,
            route_map="string",
        )],
        ipv4_unicast_networks_masks=[iosxe.BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArgs(
            mask="string",
            network="string",
            backdoor=False,
            evpn=False,
            route_map="string",
        )],
        ipv4_unicast_redistribute_connected=False,
        ipv4_unicast_redistribute_static=False,
    )])

    const bgpAddressFamilyIpv4VrfResource = new iosxe.BgpAddressFamilyIpv4Vrf("bgpAddressFamilyIpv4VrfResource", {
    afName: "string",
    asn: "string",
    deleteMode: "string",
    device: "string",
    vrfs: [{
        name: "string",
        ipv4UnicastAdvertiseL2vpnEvpn: false,
        ipv4UnicastNetworks: [{
            network: "string",
            backdoor: false,
            evpn: false,
            routeMap: "string",
        }],
        ipv4UnicastNetworksMasks: [{
            mask: "string",
            network: "string",
            backdoor: false,
            evpn: false,
            routeMap: "string",
        }],
        ipv4UnicastRedistributeConnected: false,
        ipv4UnicastRedistributeStatic: false,
    }],
});

    type: iosxe:BgpAddressFamilyIpv4Vrf
properties:
    afName: string
    asn: string
    deleteMode: string
    device: string
    vrfs:
        - ipv4UnicastAdvertiseL2vpnEvpn: false
          ipv4UnicastNetworks:
            - backdoor: false
              evpn: false
              network: string
              routeMap: string
          ipv4UnicastNetworksMasks:
            - backdoor: false
              evpn: false
              mask: string
              network: string
              routeMap: string
          ipv4UnicastRedistributeConnected: false
          ipv4UnicastRedistributeStatic: false
          name: string

    BgpAddressFamilyIpv4Vrf Resource Properties

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

    Inputs

    The BgpAddressFamilyIpv4Vrf resource accepts the following input properties:

    AfName string
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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.BgpAddressFamilyIpv4VrfVrf>
    AfName string
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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 []BgpAddressFamilyIpv4VrfVrfArgs
    afName String
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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<BgpAddressFamilyIpv4VrfVrf>
    afName string
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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 BgpAddressFamilyIpv4VrfVrf[]
    af_name str
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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[BgpAddressFamilyIpv4VrfVrfArgs]
    afName String
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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>

    Outputs

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

    Get an existing BgpAddressFamilyIpv4Vrf 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?: BgpAddressFamilyIpv4VrfState, opts?: CustomResourceOptions): BgpAddressFamilyIpv4Vrf
    @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[BgpAddressFamilyIpv4VrfVrfArgs]] = None) -> BgpAddressFamilyIpv4Vrf
    func GetBgpAddressFamilyIpv4Vrf(ctx *Context, name string, id IDInput, state *BgpAddressFamilyIpv4VrfState, opts ...ResourceOption) (*BgpAddressFamilyIpv4Vrf, error)
    public static BgpAddressFamilyIpv4Vrf Get(string name, Input<string> id, BgpAddressFamilyIpv4VrfState? state, CustomResourceOptions? opts = null)
    public static BgpAddressFamilyIpv4Vrf get(String name, Output<String> id, BgpAddressFamilyIpv4VrfState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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.BgpAddressFamilyIpv4VrfVrf>
    AfName string
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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 []BgpAddressFamilyIpv4VrfVrfArgs
    afName String
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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<BgpAddressFamilyIpv4VrfVrf>
    afName string
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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 BgpAddressFamilyIpv4VrfVrf[]
    af_name str
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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[BgpAddressFamilyIpv4VrfVrfArgs]
    afName String
    • Choices: flowspec, labeled-unicast, mdt, multicast, mvpn, sr-policy, tunnel, 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

    BgpAddressFamilyIpv4VrfVrf, BgpAddressFamilyIpv4VrfVrfArgs

    BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetwork, BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworkArgs

    Network string
    Backdoor bool
    Evpn bool
    RouteMap string
    Network string
    Backdoor bool
    Evpn bool
    RouteMap string
    network String
    backdoor Boolean
    evpn Boolean
    routeMap String
    network string
    backdoor boolean
    evpn boolean
    routeMap string
    network String
    backdoor Boolean
    evpn Boolean
    routeMap String

    BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMask, BgpAddressFamilyIpv4VrfVrfIpv4UnicastNetworksMaskArgs

    Mask string
    Network string
    Backdoor bool
    Evpn bool
    RouteMap string
    Mask string
    Network string
    Backdoor bool
    Evpn bool
    RouteMap string
    mask String
    network String
    backdoor Boolean
    evpn Boolean
    routeMap String
    mask string
    network string
    backdoor boolean
    evpn boolean
    routeMap string
    mask str
    network str
    backdoor bool
    evpn bool
    route_map str
    mask String
    network String
    backdoor Boolean
    evpn Boolean
    routeMap String

    Import

     $ pulumi import iosxe:index/bgpAddressFamilyIpv4Vrf:BgpAddressFamilyIpv4Vrf example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/with-vrf/ipv4=unicast"

    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.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
    lbrlabs/pulumi-iosxe