1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. sdn
  5. sdn/fabric
  6. Ospf
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.sdn/fabric.Ospf

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    OSPF Fabric in Proxmox SDN. Fabrics in Proxmox VE SDN provide automated routing between nodes in a cluster.

    Create Ospf Resource

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

    Constructor syntax

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

@overload
def Ospf(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         area: Optional[str] = None,
         ip_prefix: Optional[str] = None,
         resource_id: Optional[str] = None)
    func NewOspf(ctx *Context, name string, args OspfArgs, opts ...ResourceOption) (*Ospf, error)
    public Ospf(string name, OspfArgs args, CustomResourceOptions? opts = null)
    public Ospf(String name, OspfArgs args)
public Ospf(String name, OspfArgs args, CustomResourceOptions options)

    type: proxmoxve:sdn/fabric/ospf:Ospf
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 OspfArgs
    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 OspfArgs
    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 OspfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    IpPrefix string
    IPv4 prefix cidr for the fabric.
    ResourceId string
    The unique identifier of the SDN fabric.
    Area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    IpPrefix string
    IPv4 prefix cidr for the fabric.
    ResourceId string
    The unique identifier of the SDN fabric.
    area String
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix String
    IPv4 prefix cidr for the fabric.
    resourceId String
    The unique identifier of the SDN fabric.
    area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix string
    IPv4 prefix cidr for the fabric.
    resourceId string
    The unique identifier of the SDN fabric.
    area str
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ip_prefix str
    IPv4 prefix cidr for the fabric.
    resource_id str
    The unique identifier of the SDN fabric.
    area String
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix String
    IPv4 prefix cidr for the fabric.
    resourceId String
    The unique identifier of the SDN fabric.

    Outputs

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

    Get an existing Ospf 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?: OspfState, opts?: CustomResourceOptions): Ospf
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        area: Optional[str] = None,
        ip_prefix: Optional[str] = None,
        resource_id: Optional[str] = None) -> Ospf
    func GetOspf(ctx *Context, name string, id IDInput, state *OspfState, opts ...ResourceOption) (*Ospf, error)
    public static Ospf Get(string name, Input<string> id, OspfState? state, CustomResourceOptions? opts = null)
    public static Ospf get(String name, Output<String> id, OspfState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:sdn/fabric/ospf:Ospf    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:
    Area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    IpPrefix string
    IPv4 prefix cidr for the fabric.
    ResourceId string
    The unique identifier of the SDN fabric.
    Area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    IpPrefix string
    IPv4 prefix cidr for the fabric.
    ResourceId string
    The unique identifier of the SDN fabric.
    area String
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix String
    IPv4 prefix cidr for the fabric.
    resourceId String
    The unique identifier of the SDN fabric.
    area string
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix string
    IPv4 prefix cidr for the fabric.
    resourceId string
    The unique identifier of the SDN fabric.
    area str
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ip_prefix str
    IPv4 prefix cidr for the fabric.
    resource_id str
    The unique identifier of the SDN fabric.
    area String
    OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust.
    ipPrefix String
    IPv4 prefix cidr for the fabric.
    resourceId String
    The unique identifier of the SDN fabric.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.