1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getCryptoIkev2Keyring
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getCryptoIkev2Keyring

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

    This data source can read the Crypto IKEv2 Keyring configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetCryptoIkev2Keyring.Invoke(new()
        {
            Name = "keyring1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iosxe.LookupCryptoIkev2Keyring(ctx, &iosxe.LookupCryptoIkev2KeyringArgs{
    			Name: "keyring1",
    		}, 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.iosxe.IosxeFunctions;
    import com.pulumi.iosxe.inputs.GetCryptoIkev2KeyringArgs;
    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 = IosxeFunctions.getCryptoIkev2Keyring(GetCryptoIkev2KeyringArgs.builder()
                .name("keyring1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_crypto_ikev2_keyring(name="keyring1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getCryptoIkev2Keyring({
        name: "keyring1",
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getCryptoIkev2Keyring
          Arguments:
            name: keyring1
    

    Using getCryptoIkev2Keyring

    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 getCryptoIkev2Keyring(args: GetCryptoIkev2KeyringArgs, opts?: InvokeOptions): Promise<GetCryptoIkev2KeyringResult>
    function getCryptoIkev2KeyringOutput(args: GetCryptoIkev2KeyringOutputArgs, opts?: InvokeOptions): Output<GetCryptoIkev2KeyringResult>
    def get_crypto_ikev2_keyring(device: Optional[str] = None,
                                 name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCryptoIkev2KeyringResult
    def get_crypto_ikev2_keyring_output(device: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCryptoIkev2KeyringResult]
    func LookupCryptoIkev2Keyring(ctx *Context, args *LookupCryptoIkev2KeyringArgs, opts ...InvokeOption) (*LookupCryptoIkev2KeyringResult, error)
    func LookupCryptoIkev2KeyringOutput(ctx *Context, args *LookupCryptoIkev2KeyringOutputArgs, opts ...InvokeOption) LookupCryptoIkev2KeyringResultOutput

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

    public static class GetCryptoIkev2Keyring 
    {
        public static Task<GetCryptoIkev2KeyringResult> InvokeAsync(GetCryptoIkev2KeyringArgs args, InvokeOptions? opts = null)
        public static Output<GetCryptoIkev2KeyringResult> Invoke(GetCryptoIkev2KeyringInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCryptoIkev2KeyringResult> getCryptoIkev2Keyring(GetCryptoIkev2KeyringArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getCryptoIkev2Keyring:getCryptoIkev2Keyring
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Device string
    A device name from the provider configuration.
    Name string
    Device string
    A device name from the provider configuration.
    name String
    device String
    A device name from the provider configuration.
    name string
    device string
    A device name from the provider configuration.
    name str
    device str
    A device name from the provider configuration.
    name String
    device String
    A device name from the provider configuration.

    getCryptoIkev2Keyring Result

    The following output properties are available:

    Id string
    The path of the retrieved object.
    Name string
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetCryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    Device string
    A device name from the provider configuration.
    Id string
    The path of the retrieved object.
    Name string
    Peers []GetCryptoIkev2KeyringPeer
    Configure a Peer and associated keys
    Device string
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    name String
    peers List<GetCryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.
    id string
    The path of the retrieved object.
    name string
    peers GetCryptoIkev2KeyringPeer[]
    Configure a Peer and associated keys
    device string
    A device name from the provider configuration.
    id str
    The path of the retrieved object.
    name str
    peers Sequence[GetCryptoIkev2KeyringPeer]
    Configure a Peer and associated keys
    device str
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    name String
    peers List<Property Map>
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.

    Supporting Types

    GetCryptoIkev2KeyringPeer

    Description string
    Specify a description of this peer
    Hostname string
    Hostname of peer
    IdentityAddress string
    IP address
    IdentityEmailDomain string
    email Domain Name
    IdentityEmailName string
    Specify the name string
    IdentityFqdnDomain string
    email Domain Name
    IdentityFqdnName string
    Specify the name string
    IdentityKeyId string
    proprietary types of identification (ID KEY ID)
    Ipv4Address string
    Ipv4Mask string
    Ipv6Prefix string
    Name string
    PreSharedKey string
    PreSharedKeyEncryption string
    PreSharedKeyLocal string
    PreSharedKeyLocalEncryption string
    PreSharedKeyRemote string
    PreSharedKeyRemoteEncryption string
    Description string
    Specify a description of this peer
    Hostname string
    Hostname of peer
    IdentityAddress string
    IP address
    IdentityEmailDomain string
    email Domain Name
    IdentityEmailName string
    Specify the name string
    IdentityFqdnDomain string
    email Domain Name
    IdentityFqdnName string
    Specify the name string
    IdentityKeyId string
    proprietary types of identification (ID KEY ID)
    Ipv4Address string
    Ipv4Mask string
    Ipv6Prefix string
    Name string
    PreSharedKey string
    PreSharedKeyEncryption string
    PreSharedKeyLocal string
    PreSharedKeyLocalEncryption string
    PreSharedKeyRemote string
    PreSharedKeyRemoteEncryption string
    description String
    Specify a description of this peer
    hostname String
    Hostname of peer
    identityAddress String
    IP address
    identityEmailDomain String
    email Domain Name
    identityEmailName String
    Specify the name string
    identityFqdnDomain String
    email Domain Name
    identityFqdnName String
    Specify the name string
    identityKeyId String
    proprietary types of identification (ID KEY ID)
    ipv4Address String
    ipv4Mask String
    ipv6Prefix String
    name String
    preSharedKey String
    preSharedKeyEncryption String
    preSharedKeyLocal String
    preSharedKeyLocalEncryption String
    preSharedKeyRemote String
    preSharedKeyRemoteEncryption String
    description string
    Specify a description of this peer
    hostname string
    Hostname of peer
    identityAddress string
    IP address
    identityEmailDomain string
    email Domain Name
    identityEmailName string
    Specify the name string
    identityFqdnDomain string
    email Domain Name
    identityFqdnName string
    Specify the name string
    identityKeyId string
    proprietary types of identification (ID KEY ID)
    ipv4Address string
    ipv4Mask string
    ipv6Prefix string
    name string
    preSharedKey string
    preSharedKeyEncryption string
    preSharedKeyLocal string
    preSharedKeyLocalEncryption string
    preSharedKeyRemote string
    preSharedKeyRemoteEncryption string
    description str
    Specify a description of this peer
    hostname str
    Hostname of peer
    identity_address str
    IP address
    identity_email_domain str
    email Domain Name
    identity_email_name str
    Specify the name string
    identity_fqdn_domain str
    email Domain Name
    identity_fqdn_name str
    Specify the name string
    identity_key_id str
    proprietary types of identification (ID KEY ID)
    ipv4_address str
    ipv4_mask str
    ipv6_prefix str
    name str
    pre_shared_key str
    pre_shared_key_encryption str
    pre_shared_key_local str
    pre_shared_key_local_encryption str
    pre_shared_key_remote str
    pre_shared_key_remote_encryption str
    description String
    Specify a description of this peer
    hostname String
    Hostname of peer
    identityAddress String
    IP address
    identityEmailDomain String
    email Domain Name
    identityEmailName String
    Specify the name string
    identityFqdnDomain String
    email Domain Name
    identityFqdnName String
    Specify the name string
    identityKeyId String
    proprietary types of identification (ID KEY ID)
    ipv4Address String
    ipv4Mask String
    ipv6Prefix String
    name String
    preSharedKey String
    preSharedKeyEncryption String
    preSharedKeyLocal String
    preSharedKeyLocalEncryption String
    preSharedKeyRemote String
    preSharedKeyRemoteEncryption String

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs