Docs Packages
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. OspfAuthentication
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.OspfAuthentication

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

    This resource can manage the OSPF authentication configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.OspfAuthentication("example", new()
    {
        InstanceName = "OSPF1",
        InterfaceId = "eth1/10",
        Key = "0 mykey",
        KeyId = 1,
        KeySecureMode = false,
        Keychain = "mykeychain",
        Md5Key = "0 mymd5key",
        Md5KeySecureMode = false,
        Type = "none",
        VrfName = "VRF1",
    });

});

    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.NewOspfAuthentication(ctx, "example", &nxos.OspfAuthenticationArgs{
			InstanceName:     pulumi.String("OSPF1"),
			InterfaceId:      pulumi.String("eth1/10"),
			Key:              pulumi.String("0 mykey"),
			KeyId:            pulumi.Int(1),
			KeySecureMode:    pulumi.Bool(false),
			Keychain:         pulumi.String("mykeychain"),
			Md5Key:           pulumi.String("0 mymd5key"),
			Md5KeySecureMode: pulumi.Bool(false),
			Type:             pulumi.String("none"),
			VrfName:          pulumi.String("VRF1"),
		})
		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.OspfAuthentication;
import com.pulumi.nxos.OspfAuthenticationArgs;
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 OspfAuthentication("example", OspfAuthenticationArgs.builder()        
            .instanceName("OSPF1")
            .interfaceId("eth1/10")
            .key("0 mykey")
            .keyId(1)
            .keySecureMode(false)
            .keychain("mykeychain")
            .md5Key("0 mymd5key")
            .md5KeySecureMode(false)
            .type("none")
            .vrfName("VRF1")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.OspfAuthentication("example",
    instance_name="OSPF1",
    interface_id="eth1/10",
    key="0 mykey",
    key_id=1,
    key_secure_mode=False,
    keychain="mykeychain",
    md5_key="0 mymd5key",
    md5_key_secure_mode=False,
    type="none",
    vrf_name="VRF1")

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

const example = new nxos.OspfAuthentication("example", {
    instanceName: "OSPF1",
    interfaceId: "eth1/10",
    key: "0 mykey",
    keyId: 1,
    keySecureMode: false,
    keychain: "mykeychain",
    md5Key: "0 mymd5key",
    md5KeySecureMode: false,
    type: "none",
    vrfName: "VRF1",
});

    resources:
  example:
    type: nxos:OspfAuthentication
    properties:
      instanceName: OSPF1
      interfaceId: eth1/10
      key: 0 mykey
      keyId: 1
      keySecureMode: false
      keychain: mykeychain
      md5Key: 0 mymd5key
      md5KeySecureMode: false
      type: none
      vrfName: VRF1

    Create OspfAuthentication Resource

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

    Constructor syntax

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

@overload
def OspfAuthentication(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_name: Optional[str] = None,
                       interface_id: Optional[str] = None,
                       vrf_name: Optional[str] = None,
                       device: Optional[str] = None,
                       key: Optional[str] = None,
                       key_id: Optional[int] = None,
                       key_secure_mode: Optional[bool] = None,
                       keychain: Optional[str] = None,
                       md5_key: Optional[str] = None,
                       md5_key_secure_mode: Optional[bool] = None,
                       type: Optional[str] = None)
    func NewOspfAuthentication(ctx *Context, name string, args OspfAuthenticationArgs, opts ...ResourceOption) (*OspfAuthentication, error)
    public OspfAuthentication(string name, OspfAuthenticationArgs args, CustomResourceOptions? opts = null)
    public OspfAuthentication(String name, OspfAuthenticationArgs args)
public OspfAuthentication(String name, OspfAuthenticationArgs args, CustomResourceOptions options)

    type: nxos:OspfAuthentication
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 OspfAuthenticationArgs
    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 OspfAuthenticationArgs
    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 OspfAuthenticationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfAuthenticationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfAuthenticationArgs
    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 ospfAuthenticationResource = new Nxos.OspfAuthentication("ospfAuthenticationResource", new()
{
    InstanceName = "string",
    InterfaceId = "string",
    VrfName = "string",
    Device = "string",
    Key = "string",
    KeyId = 0,
    KeySecureMode = false,
    Keychain = "string",
    Md5Key = "string",
    Md5KeySecureMode = false,
    Type = "string",
});

    example, err := nxos.NewOspfAuthentication(ctx, "ospfAuthenticationResource", &nxos.OspfAuthenticationArgs{
	InstanceName:     pulumi.String("string"),
	InterfaceId:      pulumi.String("string"),
	VrfName:          pulumi.String("string"),
	Device:           pulumi.String("string"),
	Key:              pulumi.String("string"),
	KeyId:            pulumi.Int(0),
	KeySecureMode:    pulumi.Bool(false),
	Keychain:         pulumi.String("string"),
	Md5Key:           pulumi.String("string"),
	Md5KeySecureMode: pulumi.Bool(false),
	Type:             pulumi.String("string"),
})

    var ospfAuthenticationResource = new OspfAuthentication("ospfAuthenticationResource", OspfAuthenticationArgs.builder()
    .instanceName("string")
    .interfaceId("string")
    .vrfName("string")
    .device("string")
    .key("string")
    .keyId(0)
    .keySecureMode(false)
    .keychain("string")
    .md5Key("string")
    .md5KeySecureMode(false)
    .type("string")
    .build());

    ospf_authentication_resource = nxos.OspfAuthentication("ospfAuthenticationResource",
    instance_name="string",
    interface_id="string",
    vrf_name="string",
    device="string",
    key="string",
    key_id=0,
    key_secure_mode=False,
    keychain="string",
    md5_key="string",
    md5_key_secure_mode=False,
    type="string")

    const ospfAuthenticationResource = new nxos.OspfAuthentication("ospfAuthenticationResource", {
    instanceName: "string",
    interfaceId: "string",
    vrfName: "string",
    device: "string",
    key: "string",
    keyId: 0,
    keySecureMode: false,
    keychain: "string",
    md5Key: "string",
    md5KeySecureMode: false,
    type: "string",
});

    type: nxos:OspfAuthentication
properties:
    device: string
    instanceName: string
    interfaceId: string
    key: string
    keyId: 0
    keySecureMode: false
    keychain: string
    md5Key: string
    md5KeySecureMode: false
    type: string
    vrfName: string

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

    InstanceName string
    OSPF instance name.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    Key string
    Key used for authentication.
    KeyId int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    KeySecureMode bool
    Encrypted authentication key or plain text key. - Default value: false
    Keychain string
    Authentication keychain.
    Md5Key string
    Key used for md5 authentication.
    Md5KeySecureMode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    Type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    InstanceName string
    OSPF instance name.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    Key string
    Key used for authentication.
    KeyId int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    KeySecureMode bool
    Encrypted authentication key or plain text key. - Default value: false
    Keychain string
    Authentication keychain.
    Md5Key string
    Key used for md5 authentication.
    Md5KeySecureMode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    Type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    instanceName String
    OSPF instance name.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    key String
    Key used for authentication.
    keyId Integer
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode Boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain String
    Authentication keychain.
    md5Key String
    Key used for md5 authentication.
    md5KeySecureMode Boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    instanceName string
    OSPF instance name.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName string
    VRF name.
    device string
    A device name from the provider configuration.
    key string
    Key used for authentication.
    keyId number
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain string
    Authentication keychain.
    md5Key string
    Key used for md5 authentication.
    md5KeySecureMode boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    instance_name str
    OSPF instance name.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf_name str
    VRF name.
    device str
    A device name from the provider configuration.
    key str
    Key used for authentication.
    key_id int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    key_secure_mode bool
    Encrypted authentication key or plain text key. - Default value: false
    keychain str
    Authentication keychain.
    md5_key str
    Key used for md5 authentication.
    md5_key_secure_mode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    type str
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    instanceName String
    OSPF instance name.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    key String
    Key used for authentication.
    keyId Number
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode Boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain String
    Authentication keychain.
    md5Key String
    Key used for md5 authentication.
    md5KeySecureMode Boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified

    Outputs

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

    Get an existing OspfAuthentication 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?: OspfAuthenticationState, opts?: CustomResourceOptions): OspfAuthentication
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        instance_name: Optional[str] = None,
        interface_id: Optional[str] = None,
        key: Optional[str] = None,
        key_id: Optional[int] = None,
        key_secure_mode: Optional[bool] = None,
        keychain: Optional[str] = None,
        md5_key: Optional[str] = None,
        md5_key_secure_mode: Optional[bool] = None,
        type: Optional[str] = None,
        vrf_name: Optional[str] = None) -> OspfAuthentication
    func GetOspfAuthentication(ctx *Context, name string, id IDInput, state *OspfAuthenticationState, opts ...ResourceOption) (*OspfAuthentication, error)
    public static OspfAuthentication Get(string name, Input<string> id, OspfAuthenticationState? state, CustomResourceOptions? opts = null)
    public static OspfAuthentication get(String name, Output<String> id, OspfAuthenticationState 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:
    Device string
    A device name from the provider configuration.
    InstanceName string
    OSPF instance name.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Key string
    Key used for authentication.
    KeyId int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    KeySecureMode bool
    Encrypted authentication key or plain text key. - Default value: false
    Keychain string
    Authentication keychain.
    Md5Key string
    Key used for md5 authentication.
    Md5KeySecureMode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    Type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    InstanceName string
    OSPF instance name.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Key string
    Key used for authentication.
    KeyId int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    KeySecureMode bool
    Encrypted authentication key or plain text key. - Default value: false
    Keychain string
    Authentication keychain.
    Md5Key string
    Key used for md5 authentication.
    Md5KeySecureMode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    Type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    VrfName string
    VRF name.
    device String
    A device name from the provider configuration.
    instanceName String
    OSPF instance name.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    key String
    Key used for authentication.
    keyId Integer
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode Boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain String
    Authentication keychain.
    md5Key String
    Key used for md5 authentication.
    md5KeySecureMode Boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    vrfName String
    VRF name.
    device string
    A device name from the provider configuration.
    instanceName string
    OSPF instance name.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    key string
    Key used for authentication.
    keyId number
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain string
    Authentication keychain.
    md5Key string
    Key used for md5 authentication.
    md5KeySecureMode boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    vrfName string
    VRF name.
    device str
    A device name from the provider configuration.
    instance_name str
    OSPF instance name.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.
    key str
    Key used for authentication.
    key_id int
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    key_secure_mode bool
    Encrypted authentication key or plain text key. - Default value: false
    keychain str
    Authentication keychain.
    md5_key str
    Key used for md5 authentication.
    md5_key_secure_mode bool
    Encrypted authentication md5 key or plain text key. - Default value: false
    type str
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    vrf_name str
    VRF name.
    device String
    A device name from the provider configuration.
    instanceName String
    OSPF instance name.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    key String
    Key used for authentication.
    keyId Number
    Key ID used for authentication. - Range: 0-255 - Default value: 0
    keySecureMode Boolean
    Encrypted authentication key or plain text key. - Default value: false
    keychain String
    Authentication keychain.
    md5Key String
    Key used for md5 authentication.
    md5KeySecureMode Boolean
    Encrypted authentication md5 key or plain text key. - Default value: false
    type String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    vrfName String
    VRF name.

    Import

     $ pulumi import nxos:index/ospfAuthentication:OspfAuthentication example "sys/ospf/inst-[OSPF1]/dom-[VRF1]/if-[eth1/10]/authnew"

    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.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
    lbrlabs/pulumi-nxos