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

iosxe.BgpIpv6UnicastNeighbor

Explore with Pulumi AI

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

    This resource can manage the BGP IPv6 Unicast Neighbor 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.BgpIpv6UnicastNeighbor;
    import com.pulumi.iosxe.BgpIpv6UnicastNeighborArgs;
    import com.pulumi.iosxe.inputs.BgpIpv6UnicastNeighborRouteMapArgs;
    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 BgpIpv6UnicastNeighbor("example", BgpIpv6UnicastNeighborArgs.builder()        
                .activate(true)
                .asn("65000")
                .ip("3.3.3.3")
                .routeMaps(BgpIpv6UnicastNeighborRouteMapArgs.builder()
                    .in_out("in")
                    .route_map_name("RM1")
                    .build())
                .routeReflectorClient(false)
                .sendCommunity("both")
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:BgpIpv6UnicastNeighbor
        properties:
          activate: true
          asn: '65000'
          ip: 3.3.3.3
          routeMaps:
            - in_out: in
              route_map_name: RM1
          routeReflectorClient: false
          sendCommunity: both
    

    Create BgpIpv6UnicastNeighbor Resource

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

    Constructor syntax

    new BgpIpv6UnicastNeighbor(name: string, args: BgpIpv6UnicastNeighborArgs, opts?: CustomResourceOptions);
    @overload
    def BgpIpv6UnicastNeighbor(resource_name: str,
                               args: BgpIpv6UnicastNeighborArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpIpv6UnicastNeighbor(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               asn: Optional[str] = None,
                               ip: Optional[str] = None,
                               activate: Optional[bool] = None,
                               delete_mode: Optional[str] = None,
                               device: Optional[str] = None,
                               route_maps: Optional[Sequence[BgpIpv6UnicastNeighborRouteMapArgs]] = None,
                               route_reflector_client: Optional[bool] = None,
                               send_community: Optional[str] = None)
    func NewBgpIpv6UnicastNeighbor(ctx *Context, name string, args BgpIpv6UnicastNeighborArgs, opts ...ResourceOption) (*BgpIpv6UnicastNeighbor, error)
    public BgpIpv6UnicastNeighbor(string name, BgpIpv6UnicastNeighborArgs args, CustomResourceOptions? opts = null)
    public BgpIpv6UnicastNeighbor(String name, BgpIpv6UnicastNeighborArgs args)
    public BgpIpv6UnicastNeighbor(String name, BgpIpv6UnicastNeighborArgs args, CustomResourceOptions options)
    
    type: iosxe:BgpIpv6UnicastNeighbor
    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 BgpIpv6UnicastNeighborArgs
    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 BgpIpv6UnicastNeighborArgs
    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 BgpIpv6UnicastNeighborArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpIpv6UnicastNeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpIpv6UnicastNeighborArgs
    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 bgpIpv6UnicastNeighborResource = new Iosxe.BgpIpv6UnicastNeighbor("bgpIpv6UnicastNeighborResource", new()
    {
        Asn = "string",
        Ip = "string",
        Activate = false,
        DeleteMode = "string",
        Device = "string",
        RouteMaps = new[]
        {
            new Iosxe.Inputs.BgpIpv6UnicastNeighborRouteMapArgs
            {
                InOut = "string",
                RouteMapName = "string",
            },
        },
        RouteReflectorClient = false,
        SendCommunity = "string",
    });
    
    example, err := iosxe.NewBgpIpv6UnicastNeighbor(ctx, "bgpIpv6UnicastNeighborResource", &iosxe.BgpIpv6UnicastNeighborArgs{
    	Asn:        pulumi.String("string"),
    	Ip:         pulumi.String("string"),
    	Activate:   pulumi.Bool(false),
    	DeleteMode: pulumi.String("string"),
    	Device:     pulumi.String("string"),
    	RouteMaps: iosxe.BgpIpv6UnicastNeighborRouteMapArray{
    		&iosxe.BgpIpv6UnicastNeighborRouteMapArgs{
    			InOut:        pulumi.String("string"),
    			RouteMapName: pulumi.String("string"),
    		},
    	},
    	RouteReflectorClient: pulumi.Bool(false),
    	SendCommunity:        pulumi.String("string"),
    })
    
    var bgpIpv6UnicastNeighborResource = new BgpIpv6UnicastNeighbor("bgpIpv6UnicastNeighborResource", BgpIpv6UnicastNeighborArgs.builder()        
        .asn("string")
        .ip("string")
        .activate(false)
        .deleteMode("string")
        .device("string")
        .routeMaps(BgpIpv6UnicastNeighborRouteMapArgs.builder()
            .inOut("string")
            .routeMapName("string")
            .build())
        .routeReflectorClient(false)
        .sendCommunity("string")
        .build());
    
    bgp_ipv6_unicast_neighbor_resource = iosxe.BgpIpv6UnicastNeighbor("bgpIpv6UnicastNeighborResource",
        asn="string",
        ip="string",
        activate=False,
        delete_mode="string",
        device="string",
        route_maps=[iosxe.BgpIpv6UnicastNeighborRouteMapArgs(
            in_out="string",
            route_map_name="string",
        )],
        route_reflector_client=False,
        send_community="string")
    
    const bgpIpv6UnicastNeighborResource = new iosxe.BgpIpv6UnicastNeighbor("bgpIpv6UnicastNeighborResource", {
        asn: "string",
        ip: "string",
        activate: false,
        deleteMode: "string",
        device: "string",
        routeMaps: [{
            inOut: "string",
            routeMapName: "string",
        }],
        routeReflectorClient: false,
        sendCommunity: "string",
    });
    
    type: iosxe:BgpIpv6UnicastNeighbor
    properties:
        activate: false
        asn: string
        deleteMode: string
        device: string
        ip: string
        routeMaps:
            - inOut: string
              routeMapName: string
        routeReflectorClient: false
        sendCommunity: string
    

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

    Asn string
    Ip string
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv6UnicastNeighborRouteMap>
    Apply route map to neighbor
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    Asn string
    Ip string
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    RouteMaps []BgpIpv6UnicastNeighborRouteMapArgs
    Apply route map to neighbor
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    asn String
    ip String
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeMaps List<BgpIpv6UnicastNeighborRouteMap>
    Apply route map to neighbor
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard
    asn string
    ip string
    activate boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeMaps BgpIpv6UnicastNeighborRouteMap[]
    Apply route map to neighbor
    routeReflectorClient boolean
    Configure a neighbor as Route Reflector client
    sendCommunity string
    • Choices: both, extended, standard
    asn str
    ip str
    activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    route_maps Sequence[BgpIpv6UnicastNeighborRouteMapArgs]
    Apply route map to neighbor
    route_reflector_client bool
    Configure a neighbor as Route Reflector client
    send_community str
    • Choices: both, extended, standard
    asn String
    ip String
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    routeMaps List<Property Map>
    Apply route map to neighbor
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard

    Outputs

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

    Get an existing BgpIpv6UnicastNeighbor 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?: BgpIpv6UnicastNeighborState, opts?: CustomResourceOptions): BgpIpv6UnicastNeighbor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activate: Optional[bool] = None,
            asn: Optional[str] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            ip: Optional[str] = None,
            route_maps: Optional[Sequence[BgpIpv6UnicastNeighborRouteMapArgs]] = None,
            route_reflector_client: Optional[bool] = None,
            send_community: Optional[str] = None) -> BgpIpv6UnicastNeighbor
    func GetBgpIpv6UnicastNeighbor(ctx *Context, name string, id IDInput, state *BgpIpv6UnicastNeighborState, opts ...ResourceOption) (*BgpIpv6UnicastNeighbor, error)
    public static BgpIpv6UnicastNeighbor Get(string name, Input<string> id, BgpIpv6UnicastNeighborState? state, CustomResourceOptions? opts = null)
    public static BgpIpv6UnicastNeighbor get(String name, Output<String> id, BgpIpv6UnicastNeighborState 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:
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    Ip string
    RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv6UnicastNeighborRouteMap>
    Apply route map to neighbor
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    Activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    Ip string
    RouteMaps []BgpIpv6UnicastNeighborRouteMapArgs
    Apply route map to neighbor
    RouteReflectorClient bool
    Configure a neighbor as Route Reflector client
    SendCommunity string
    • Choices: both, extended, standard
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip String
    routeMaps List<BgpIpv6UnicastNeighborRouteMap>
    Apply route map to neighbor
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard
    activate boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip string
    routeMaps BgpIpv6UnicastNeighborRouteMap[]
    Apply route map to neighbor
    routeReflectorClient boolean
    Configure a neighbor as Route Reflector client
    sendCommunity string
    • Choices: both, extended, standard
    activate bool
    Enable the address family for this neighbor - Default value: true
    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.
    ip str
    route_maps Sequence[BgpIpv6UnicastNeighborRouteMapArgs]
    Apply route map to neighbor
    route_reflector_client bool
    Configure a neighbor as Route Reflector client
    send_community str
    • Choices: both, extended, standard
    activate Boolean
    Enable the address family for this neighbor - Default value: true
    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.
    ip String
    routeMaps List<Property Map>
    Apply route map to neighbor
    routeReflectorClient Boolean
    Configure a neighbor as Route Reflector client
    sendCommunity String
    • Choices: both, extended, standard

    Supporting Types

    BgpIpv6UnicastNeighborRouteMap, BgpIpv6UnicastNeighborRouteMapArgs

    InOut string
    RouteMapName string
    InOut string
    RouteMapName string
    inOut String
    routeMapName String
    inOut string
    routeMapName string
    inOut String
    routeMapName String

    Import

     $ pulumi import iosxe:index/bgpIpv6UnicastNeighbor:BgpIpv6UnicastNeighbor example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/no-vrf/ipv6=unicast/ipv6-unicast/neighbor=3.3.3.3"
    

    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