Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
nxos.getOspfAuthentication
Explore with Pulumi AI
This data source can read the OSPF authentication configuration.
- API Documentation: ospfAuthNewP
 
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 * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";
const example = nxos.getOspfAuthentication({
    instanceName: "OSPF1",
    interfaceId: "eth1/10",
    vrfName: "VRF1",
});
import pulumi
import pulumi_nxos as nxos
example = nxos.get_ospf_authentication(instance_name="OSPF1",
    interface_id="eth1/10",
    vrf_name="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)
public static Output<GetOspfAuthenticationResult> getOspfAuthentication(GetOspfAuthenticationArgs args, InvokeOptions options)
fn::invoke:
  function: nxos:index/getOspfAuthentication:getOspfAuthentication
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Instance
Name string - OSPF instance name.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Vrf
Name string - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- Instance
Name string - OSPF instance name.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Vrf
Name string - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- instance
Name String - OSPF instance name.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - vrf
Name String - VRF name.
 - device String
 - A device name from the provider configuration.
 
- instance
Name string - OSPF instance name.
 - interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - vrf
Name 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.
 
- instance
Name String - OSPF instance name.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - vrf
Name 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.
 - Instance
Name string - OSPF instance name.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Key string
 - Key used for authentication.
 - Key
Id int - Key ID used for authentication.
 - Key
Secure boolMode  - Encrypted authentication key or plain text key.
 - Keychain string
 - Authentication keychain.
 - Md5Key string
 - Key used for md5 authentication.
 - Md5Key
Secure boolMode  - Encrypted authentication md5 key or plain text key.
 - Type string
 - Authentication type.
 - Vrf
Name string - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- Id string
 - The distinguished name of the object.
 - Instance
Name string - OSPF instance name.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Key string
 - Key used for authentication.
 - Key
Id int - Key ID used for authentication.
 - Key
Secure boolMode  - Encrypted authentication key or plain text key.
 - Keychain string
 - Authentication keychain.
 - Md5Key string
 - Key used for md5 authentication.
 - Md5Key
Secure boolMode  - Encrypted authentication md5 key or plain text key.
 - Type string
 - Authentication type.
 - Vrf
Name string - VRF name.
 - Device string
 - A device name from the provider configuration.
 
- id String
 - The distinguished name of the object.
 - instance
Name String - OSPF instance name.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - key String
 - Key used for authentication.
 - key
Id Integer - Key ID used for authentication.
 - key
Secure BooleanMode  - Encrypted authentication key or plain text key.
 - keychain String
 - Authentication keychain.
 - md5Key String
 - Key used for md5 authentication.
 - md5Key
Secure BooleanMode  - Encrypted authentication md5 key or plain text key.
 - type String
 - Authentication type.
 - vrf
Name String - VRF name.
 - device String
 - A device name from the provider configuration.
 
- id string
 - The distinguished name of the object.
 - instance
Name string - OSPF instance name.
 - interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - key string
 - Key used for authentication.
 - key
Id number - Key ID used for authentication.
 - key
Secure booleanMode  - Encrypted authentication key or plain text key.
 - keychain string
 - Authentication keychain.
 - md5Key string
 - Key used for md5 authentication.
 - md5Key
Secure booleanMode  - Encrypted authentication md5 key or plain text key.
 - type string
 - Authentication type.
 - vrf
Name 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_ boolmode  - Encrypted authentication key or plain text key.
 - keychain str
 - Authentication keychain.
 - md5_
key str - Key used for md5 authentication.
 - md5_
key_ boolsecure_ mode  - 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.
 - instance
Name String - OSPF instance name.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - key String
 - Key used for authentication.
 - key
Id Number - Key ID used for authentication.
 - key
Secure BooleanMode  - Encrypted authentication key or plain text key.
 - keychain String
 - Authentication keychain.
 - md5Key String
 - Key used for md5 authentication.
 - md5Key
Secure BooleanMode  - Encrypted authentication md5 key or plain text key.
 - type String
 - Authentication type.
 - vrf
Name 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 
nxosTerraform Provider.