nxos.getOspfAuthentication

Explore with Pulumi AI

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetOspfAuthentication.Invoke(new()
    {
        InstanceName = "OSPF1",
        InterfaceId = "eth1/10",
        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.LookupOspfAuthentication(ctx, &nxos.LookupOspfAuthenticationArgs{
			InstanceName: "OSPF1",
			InterfaceId:  "eth1/10",
			VrfName:      "VRF1",
		}, nil)
		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.NxosFunctions;
import com.pulumi.nxos.inputs.GetOspfAuthenticationArgs;
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) {
        final var example = NxosFunctions.getOspfAuthentication(GetOspfAuthenticationArgs.builder()
            .instanceName("OSPF1")
            .interfaceId("eth1/10")
            .vrfName("VRF1")
            .build());

    }
}

import pulumi
import pulumi_nxos as nxos

example = nxos.get_ospf_authentication(instance_name="OSPF1",
    interface_id="eth1/10",
    vrf_name="VRF1")

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

const example = nxos.getOspfAuthentication({
    instanceName: "OSPF1",
    interfaceId: "eth1/10",
    vrfName: "VRF1",
});

variables:
  example:
    fn::invoke:
      Function: nxos:getOspfAuthentication
      Arguments:
        instanceName: OSPF1
        interfaceId: eth1/10
        vrfName: VRF1

Using getOspfAuthentication

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOspfAuthentication(args: GetOspfAuthenticationArgs, opts?: InvokeOptions): Promise<GetOspfAuthenticationResult>
function getOspfAuthenticationOutput(args: GetOspfAuthenticationOutputArgs, opts?: InvokeOptions): Output<GetOspfAuthenticationResult>

def get_ospf_authentication(device: Optional[str] = None,
                            instance_name: Optional[str] = None,
                            interface_id: Optional[str] = None,
                            vrf_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOspfAuthenticationResult
def get_ospf_authentication_output(device: Optional[pulumi.Input[str]] = None,
                            instance_name: Optional[pulumi.Input[str]] = None,
                            interface_id: Optional[pulumi.Input[str]] = None,
                            vrf_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOspfAuthenticationResult]

func LookupOspfAuthentication(ctx *Context, args *LookupOspfAuthenticationArgs, opts ...InvokeOption) (*LookupOspfAuthenticationResult, error)
func LookupOspfAuthenticationOutput(ctx *Context, args *LookupOspfAuthenticationOutputArgs, opts ...InvokeOption) LookupOspfAuthenticationResultOutput

> Note: This function is named LookupOspfAuthentication in the Go SDK.

public static class GetOspfAuthentication 
{
    public static Task<GetOspfAuthenticationResult> InvokeAsync(GetOspfAuthenticationArgs args, InvokeOptions? opts = null)
    public static Output<GetOspfAuthenticationResult> Invoke(GetOspfAuthenticationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOspfAuthenticationResult> getOspfAuthentication(GetOspfAuthenticationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: nxos:index/getOspfAuthentication:getOspfAuthentication
  arguments:
    # arguments dictionary

The following arguments are supported:

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.

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.

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.

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.

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.

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.

getOspfAuthentication Result

The following output properties are available:

Id string: The distinguished name of the object.
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.
KeySecureMode bool: Encrypted authentication key or plain text key.
Keychain string: Authentication keychain.
Md5Key string: Key used for md5 authentication.
Md5KeySecureMode bool: Encrypted authentication md5 key or plain text key.
Type string: Authentication type.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

Id string: The distinguished name of the object.
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.
KeySecureMode bool: Encrypted authentication key or plain text key.
Keychain string: Authentication keychain.
Md5Key string: Key used for md5 authentication.
Md5KeySecureMode bool: Encrypted authentication md5 key or plain text key.
Type string: Authentication type.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

id String: The distinguished name of the object.
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.
keySecureMode Boolean: Encrypted authentication key or plain text key.
keychain String: Authentication keychain.
md5Key String: Key used for md5 authentication.
md5KeySecureMode Boolean: Encrypted authentication md5 key or plain text key.
type String: Authentication type.
vrfName String: VRF name.
device String: A device name from the provider configuration.

id string: The distinguished name of the object.
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.
keySecureMode boolean: Encrypted authentication key or plain text key.
keychain string: Authentication keychain.
md5Key string: Key used for md5 authentication.
md5KeySecureMode boolean: Encrypted authentication md5 key or plain text key.
type string: Authentication type.
vrfName string: VRF name.
device string: A device name from the provider configuration.

id str: The distinguished name of the object.
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.
key_secure_mode bool: Encrypted authentication key or plain text key.
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.
type str: Authentication type.
vrf_name str: VRF name.
device str: A device name from the provider configuration.

id String: The distinguished name of the object.
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.
keySecureMode Boolean: Encrypted authentication key or plain text key.
keychain String: Authentication keychain.
md5Key String: Key used for md5 authentication.
md5KeySecureMode Boolean: Encrypted authentication md5 key or plain text key.
type String: Authentication type.
vrfName String: VRF name.
device String: A device name from the provider configuration.

Package Details

Repository: nxos lbrlabs/pulumi-nxos
License: Apache-2.0
Notes: This Pulumi package is based on the nxos Terraform Provider.

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

lbrlabs/pulumi-nxos

nxos.getOspfAuthentication

On this page

On this page

Example Usage

Using getOspfAuthentication

getOspfAuthentication Result

Package Details

On this page

On this page