Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. InterfaceOspfv3
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.InterfaceOspfv3

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 Interface OSPFv3 configuration.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Lbrlabs.PulumiPackage.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = new Iosxe.InterfaceOspfv3("example", new()
    {
        Cost = 1000,
        NetworkTypeBroadcast = false,
        NetworkTypeNonBroadcast = false,
        NetworkTypePointToMultipoint = false,
        NetworkTypePointToPoint = true,
        Type = "Loopback",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.NewInterfaceOspfv3(ctx, "example", &iosxe.InterfaceOspfv3Args{
			Cost:                         pulumi.Int(1000),
			NetworkTypeBroadcast:         pulumi.Bool(false),
			NetworkTypeNonBroadcast:      pulumi.Bool(false),
			NetworkTypePointToMultipoint: pulumi.Bool(false),
			NetworkTypePointToPoint:      pulumi.Bool(true),
			Type:                         pulumi.String("Loopback"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.InterfaceOspfv3;
import com.pulumi.iosxe.InterfaceOspfv3Args;
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 InterfaceOspfv3("example", InterfaceOspfv3Args.builder()        
            .cost(1000)
            .networkTypeBroadcast(false)
            .networkTypeNonBroadcast(false)
            .networkTypePointToMultipoint(false)
            .networkTypePointToPoint(true)
            .type("Loopback")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@lbrlabs/pulumi-iosxe";

const example = new iosxe.InterfaceOspfv3("example", {
    cost: 1000,
    networkTypeBroadcast: false,
    networkTypeNonBroadcast: false,
    networkTypePointToMultipoint: false,
    networkTypePointToPoint: true,
    type: "Loopback",
});

    import pulumi
import lbrlabs_pulumi_iosxe as iosxe

example = iosxe.InterfaceOspfv3("example",
    cost=1000,
    network_type_broadcast=False,
    network_type_non_broadcast=False,
    network_type_point_to_multipoint=False,
    network_type_point_to_point=True,
    type="Loopback")

    resources:
  example:
    type: iosxe:InterfaceOspfv3
    properties:
      cost: 1000
      networkTypeBroadcast: false
      networkTypeNonBroadcast: false
      networkTypePointToMultipoint: false
      networkTypePointToPoint: true
      type: Loopback

    Create InterfaceOspfv3 Resource

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

    Constructor syntax

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

@overload
def InterfaceOspfv3(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    type: Optional[str] = None,
                    cost: Optional[int] = None,
                    delete_mode: Optional[str] = None,
                    device: Optional[str] = None,
                    name: Optional[str] = None,
                    network_type_broadcast: Optional[bool] = None,
                    network_type_non_broadcast: Optional[bool] = None,
                    network_type_point_to_multipoint: Optional[bool] = None,
                    network_type_point_to_point: Optional[bool] = None)
    func NewInterfaceOspfv3(ctx *Context, name string, args InterfaceOspfv3Args, opts ...ResourceOption) (*InterfaceOspfv3, error)
    public InterfaceOspfv3(string name, InterfaceOspfv3Args args, CustomResourceOptions? opts = null)
    public InterfaceOspfv3(String name, InterfaceOspfv3Args args)
public InterfaceOspfv3(String name, InterfaceOspfv3Args args, CustomResourceOptions options)

    type: iosxe:InterfaceOspfv3
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 InterfaceOspfv3Args
    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 InterfaceOspfv3Args
    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 InterfaceOspfv3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfaceOspfv3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfaceOspfv3Args
    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 interfaceOspfv3Resource = new Iosxe.InterfaceOspfv3("interfaceOspfv3Resource", new()
{
    Type = "string",
    Cost = 0,
    DeleteMode = "string",
    Device = "string",
    Name = "string",
    NetworkTypeBroadcast = false,
    NetworkTypeNonBroadcast = false,
    NetworkTypePointToMultipoint = false,
    NetworkTypePointToPoint = false,
});

    example, err := iosxe.NewInterfaceOspfv3(ctx, "interfaceOspfv3Resource", &iosxe.InterfaceOspfv3Args{
	Type:                         pulumi.String("string"),
	Cost:                         pulumi.Int(0),
	DeleteMode:                   pulumi.String("string"),
	Device:                       pulumi.String("string"),
	Name:                         pulumi.String("string"),
	NetworkTypeBroadcast:         pulumi.Bool(false),
	NetworkTypeNonBroadcast:      pulumi.Bool(false),
	NetworkTypePointToMultipoint: pulumi.Bool(false),
	NetworkTypePointToPoint:      pulumi.Bool(false),
})

    var interfaceOspfv3Resource = new InterfaceOspfv3("interfaceOspfv3Resource", InterfaceOspfv3Args.builder()
    .type("string")
    .cost(0)
    .deleteMode("string")
    .device("string")
    .name("string")
    .networkTypeBroadcast(false)
    .networkTypeNonBroadcast(false)
    .networkTypePointToMultipoint(false)
    .networkTypePointToPoint(false)
    .build());

    interface_ospfv3_resource = iosxe.InterfaceOspfv3("interfaceOspfv3Resource",
    type="string",
    cost=0,
    delete_mode="string",
    device="string",
    name="string",
    network_type_broadcast=False,
    network_type_non_broadcast=False,
    network_type_point_to_multipoint=False,
    network_type_point_to_point=False)

    const interfaceOspfv3Resource = new iosxe.InterfaceOspfv3("interfaceOspfv3Resource", {
    type: "string",
    cost: 0,
    deleteMode: "string",
    device: "string",
    name: "string",
    networkTypeBroadcast: false,
    networkTypeNonBroadcast: false,
    networkTypePointToMultipoint: false,
    networkTypePointToPoint: false,
});

    type: iosxe:InterfaceOspfv3
properties:
    cost: 0
    deleteMode: string
    device: string
    name: string
    networkTypeBroadcast: false
    networkTypeNonBroadcast: false
    networkTypePointToMultipoint: false
    networkTypePointToPoint: false
    type: string

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

    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    Name string
    NetworkTypeBroadcast bool
    Specify OSPF broadcast multi-access network
    NetworkTypeNonBroadcast bool
    Specify OSPF NBMA network
    NetworkTypePointToMultipoint bool
    Specify OSPF point-to-multipoint network
    NetworkTypePointToPoint bool
    Specify OSPF point-to-point network
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    Name string
    NetworkTypeBroadcast bool
    Specify OSPF broadcast multi-access network
    NetworkTypeNonBroadcast bool
    Specify OSPF NBMA network
    NetworkTypePointToMultipoint bool
    Specify OSPF point-to-multipoint network
    NetworkTypePointToPoint bool
    Specify OSPF point-to-point network
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost Integer
    Static route cost value of the interface - Range: 1-65535
    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.
    name String
    networkTypeBroadcast Boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast Boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint Boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint Boolean
    Specify OSPF point-to-point network
    type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost number
    Static route cost value of the interface - Range: 1-65535
    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.
    name string
    networkTypeBroadcast boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint boolean
    Specify OSPF point-to-point network
    type str
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    name str
    network_type_broadcast bool
    Specify OSPF broadcast multi-access network
    network_type_non_broadcast bool
    Specify OSPF NBMA network
    network_type_point_to_multipoint bool
    Specify OSPF point-to-multipoint network
    network_type_point_to_point bool
    Specify OSPF point-to-point network
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost Number
    Static route cost value of the interface - Range: 1-65535
    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.
    name String
    networkTypeBroadcast Boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast Boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint Boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint Boolean
    Specify OSPF point-to-point network

    Outputs

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

    Get an existing InterfaceOspfv3 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?: InterfaceOspfv3State, opts?: CustomResourceOptions): InterfaceOspfv3
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cost: Optional[int] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        name: Optional[str] = None,
        network_type_broadcast: Optional[bool] = None,
        network_type_non_broadcast: Optional[bool] = None,
        network_type_point_to_multipoint: Optional[bool] = None,
        network_type_point_to_point: Optional[bool] = None,
        type: Optional[str] = None) -> InterfaceOspfv3
    func GetInterfaceOspfv3(ctx *Context, name string, id IDInput, state *InterfaceOspfv3State, opts ...ResourceOption) (*InterfaceOspfv3, error)
    public static InterfaceOspfv3 Get(string name, Input<string> id, InterfaceOspfv3State? state, CustomResourceOptions? opts = null)
    public static InterfaceOspfv3 get(String name, Output<String> id, InterfaceOspfv3State state, CustomResourceOptions options)
    resources:  _:    type: iosxe:InterfaceOspfv3    get:      id: ${id}
    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:
    Cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    Name string
    NetworkTypeBroadcast bool
    Specify OSPF broadcast multi-access network
    NetworkTypeNonBroadcast bool
    Specify OSPF NBMA network
    NetworkTypePointToMultipoint bool
    Specify OSPF point-to-multipoint network
    NetworkTypePointToPoint bool
    Specify OSPF point-to-point network
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    Name string
    NetworkTypeBroadcast bool
    Specify OSPF broadcast multi-access network
    NetworkTypeNonBroadcast bool
    Specify OSPF NBMA network
    NetworkTypePointToMultipoint bool
    Specify OSPF point-to-multipoint network
    NetworkTypePointToPoint bool
    Specify OSPF point-to-point network
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost Integer
    Static route cost value of the interface - Range: 1-65535
    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.
    name String
    networkTypeBroadcast Boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast Boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint Boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint Boolean
    Specify OSPF point-to-point network
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost number
    Static route cost value of the interface - Range: 1-65535
    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.
    name string
    networkTypeBroadcast boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint boolean
    Specify OSPF point-to-point network
    type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost int
    Static route cost value of the interface - Range: 1-65535
    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.
    name str
    network_type_broadcast bool
    Specify OSPF broadcast multi-access network
    network_type_non_broadcast bool
    Specify OSPF NBMA network
    network_type_point_to_multipoint bool
    Specify OSPF point-to-multipoint network
    network_type_point_to_point bool
    Specify OSPF point-to-point network
    type str
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    cost Number
    Static route cost value of the interface - Range: 1-65535
    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.
    name String
    networkTypeBroadcast Boolean
    Specify OSPF broadcast multi-access network
    networkTypeNonBroadcast Boolean
    Specify OSPF NBMA network
    networkTypePointToMultipoint Boolean
    Specify OSPF point-to-multipoint network
    networkTypePointToPoint Boolean
    Specify OSPF point-to-point network
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel

    Import

     $ pulumi import iosxe:index/interfaceOspfv3:InterfaceOspfv3 example "Cisco-IOS-XE-native:native/interface/Loopback=1/Cisco-IOS-XE-ospfv3:ospfv3"

    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