nxos.Ospf
Explore with Pulumi AI
This resource can manage the global OSPF configuration.
- API Documentation: ospfEntity
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Lbrlabs.PulumiPackage.Nxos;
return await Deployment.RunAsync(() =>
{
var example = new Nxos.Ospf("example", new()
{
AdminState = "enabled",
});
});
package main
import (
"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := nxos.NewOspf(ctx, "example", &nxos.OspfArgs{
AdminState: pulumi.String("enabled"),
})
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.nxos.Ospf;
import com.pulumi.nxos.OspfArgs;
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 Ospf("example", OspfArgs.builder()
.adminState("enabled")
.build());
}
}
import pulumi
import lbrlabs_pulumi_nxos as nxos
example = nxos.Ospf("example", admin_state="enabled")
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";
const example = new nxos.Ospf("example", {adminState: "enabled"});
resources:
example:
type: nxos:Ospf
properties:
adminState: enabled
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: Optional[OspfArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Ospf(resource_name: str,
opts: Optional[ResourceOptions] = None,
admin_state: Optional[str] = None,
device: Optional[str] = None)
func NewOspf(ctx *Context, name string, args *OspfArgs, opts ...ResourceOption) (*Ospf, error)
public Ospf(string name, OspfArgs? args = null, CustomResourceOptions? opts = null)
type: nxos: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.
Constructor example
The following reference example uses placeholder values for all input properties.
var ospfResource = new Nxos.Ospf("ospfResource", new()
{
AdminState = "string",
Device = "string",
});
example, err := nxos.NewOspf(ctx, "ospfResource", &nxos.OspfArgs{
AdminState: pulumi.String("string"),
Device: pulumi.String("string"),
})
var ospfResource = new Ospf("ospfResource", OspfArgs.builder()
.adminState("string")
.device("string")
.build());
ospf_resource = nxos.Ospf("ospfResource",
admin_state="string",
device="string")
const ospfResource = new nxos.Ospf("ospfResource", {
adminState: "string",
device: "string",
});
type: nxos:Ospf
properties:
adminState: string
device: string
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:
- Admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- Device string
- A device name from the provider configuration.
- Admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- Device string
- A device name from the provider configuration.
- admin
State String - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device String
- A device name from the provider configuration.
- admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device string
- A device name from the provider configuration.
- admin_
state str - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device str
- A device name from the provider configuration.
- admin
State String - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device String
- A device name from the provider configuration.
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,
admin_state: Optional[str] = None,
device: 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)
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.
- Admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- Device string
- A device name from the provider configuration.
- Admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- Device string
- A device name from the provider configuration.
- admin
State String - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device String
- A device name from the provider configuration.
- admin
State string - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device string
- A device name from the provider configuration.
- admin_
state str - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device str
- A device name from the provider configuration.
- admin
State String - Administrative state. - Choices:
enabled
,disabled
- Default value:enabled
- device String
- A device name from the provider configuration.
Import
$ pulumi import nxos:index/ospf:Ospf example "sys/ospf"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- nxos lbrlabs/pulumi-nxos
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
nxos
Terraform Provider.