The OSPF instance is the highest hierarchical OSPF configuration object in a domain. The OSPF instance allows you to assign global import and export routing policies for OSPF traffic in the domain.


  • ip_type: The IP Type of the OSPF Instance, currently only IPv4 is supported.
  • ospf_type: Type of the OSPF protocol, possible values are OSPFv2 and OSPFv3.
  • name (Mandatory): Name of OSPF Instance
  • last_updated_by: ID of the user who last updated the object.
  • last_updated_date: Time stamp when this object was last updated.
  • description: Description of OSPF Instance
  • embedded_metadata: Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
  • entity_scope: Specify if scope of entity is Data center or Enterprise level
  • creation_date: Time stamp when this object was created.
  • preference: Preference for OSPF Internal Routes.
  • associated_export_routing_policy_id: Export OSPF Routing Policy ID
  • associated_import_routing_policy_id: Import OSPF Routing Policy ID
  • super_backbone_enabled: Flag to determine whether SuperBackbone is enabled or not.
  • owner: Identifies the user that has created this object.
  • export_limit: This command configures the maximum number of routes (prefixes) that can be exported into OSPF from the route table.
  • export_to_overlay: Flag which determines whether the routes learnt through BGP and OSPF will be exported to VSC or not. This flag also exists in the NSGRoutingPolicyBinding entity. The NSGRoutingPolicyBinding flag takes precedence over this one.
  • external_id: External object ID. Used for integration with third party systems
  • external_preference: Preference for OSPF External Routes.


class fetcher
nupermission.NUPermission permissions
numetadata.NUMetadata metadatas
nuglobalmetadata.NUGlobalMetadata global_metadatas
nuospfarea.NUOSPFArea ospf_areas