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

iosxe.CryptoIkev2

Explore with Pulumi AI

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

    This resource can manage the Crypto IKEv2 configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Lbrlabs.PulumiPackage.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Iosxe.CryptoIkev2("example", new()
        {
            Dpd = 10,
            DpdQuery = "periodic",
            DpdRetryInterval = 5,
            NatKeepalive = 20,
        });
    
    });
    
    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.NewCryptoIkev2(ctx, "example", &iosxe.CryptoIkev2Args{
    			Dpd:              pulumi.Int(10),
    			DpdQuery:         pulumi.String("periodic"),
    			DpdRetryInterval: pulumi.Int(5),
    			NatKeepalive:     pulumi.Int(20),
    		})
    		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.CryptoIkev2;
    import com.pulumi.iosxe.CryptoIkev2Args;
    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 CryptoIkev2("example", CryptoIkev2Args.builder()        
                .dpd(10)
                .dpdQuery("periodic")
                .dpdRetryInterval(5)
                .natKeepalive(20)
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.CryptoIkev2("example",
        dpd=10,
        dpd_query="periodic",
        dpd_retry_interval=5,
        nat_keepalive=20)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.CryptoIkev2("example", {
        dpd: 10,
        dpdQuery: "periodic",
        dpdRetryInterval: 5,
        natKeepalive: 20,
    });
    
    resources:
      example:
        type: iosxe:CryptoIkev2
        properties:
          dpd: 10
          dpdQuery: periodic
          dpdRetryInterval: 5
          natKeepalive: 20
    

    Create CryptoIkev2 Resource

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

    Constructor syntax

    new CryptoIkev2(name: string, args?: CryptoIkev2Args, opts?: CustomResourceOptions);
    @overload
    def CryptoIkev2(resource_name: str,
                    args: Optional[CryptoIkev2Args] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def CryptoIkev2(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    delete_mode: Optional[str] = None,
                    device: Optional[str] = None,
                    dpd: Optional[int] = None,
                    dpd_query: Optional[str] = None,
                    dpd_retry_interval: Optional[int] = None,
                    nat_keepalive: Optional[int] = None)
    func NewCryptoIkev2(ctx *Context, name string, args *CryptoIkev2Args, opts ...ResourceOption) (*CryptoIkev2, error)
    public CryptoIkev2(string name, CryptoIkev2Args? args = null, CustomResourceOptions? opts = null)
    public CryptoIkev2(String name, CryptoIkev2Args args)
    public CryptoIkev2(String name, CryptoIkev2Args args, CustomResourceOptions options)
    
    type: iosxe:CryptoIkev2
    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 CryptoIkev2Args
    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 CryptoIkev2Args
    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 CryptoIkev2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CryptoIkev2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CryptoIkev2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var cryptoIkev2Resource = new Iosxe.CryptoIkev2("cryptoIkev2Resource", new()
    {
        DeleteMode = "string",
        Device = "string",
        Dpd = 0,
        DpdQuery = "string",
        DpdRetryInterval = 0,
        NatKeepalive = 0,
    });
    
    example, err := iosxe.NewCryptoIkev2(ctx, "cryptoIkev2Resource", &iosxe.CryptoIkev2Args{
    	DeleteMode:       pulumi.String("string"),
    	Device:           pulumi.String("string"),
    	Dpd:              pulumi.Int(0),
    	DpdQuery:         pulumi.String("string"),
    	DpdRetryInterval: pulumi.Int(0),
    	NatKeepalive:     pulumi.Int(0),
    })
    
    var cryptoIkev2Resource = new CryptoIkev2("cryptoIkev2Resource", CryptoIkev2Args.builder()        
        .deleteMode("string")
        .device("string")
        .dpd(0)
        .dpdQuery("string")
        .dpdRetryInterval(0)
        .natKeepalive(0)
        .build());
    
    crypto_ikev2_resource = iosxe.CryptoIkev2("cryptoIkev2Resource",
        delete_mode="string",
        device="string",
        dpd=0,
        dpd_query="string",
        dpd_retry_interval=0,
        nat_keepalive=0)
    
    const cryptoIkev2Resource = new iosxe.CryptoIkev2("cryptoIkev2Resource", {
        deleteMode: "string",
        device: "string",
        dpd: 0,
        dpdQuery: "string",
        dpdRetryInterval: 0,
        natKeepalive: 0,
    });
    
    type: iosxe:CryptoIkev2
    properties:
        deleteMode: string
        device: string
        dpd: 0
        dpdQuery: string
        dpdRetryInterval: 0
        natKeepalive: 0
    

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

    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    DpdQuery string
    • Choices: on-demand, periodic
    DpdRetryInterval int
    • Range: 2-60
    NatKeepalive int
    Set NAT keepalive interval - Range: 5-3600
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    DpdQuery string
    • Choices: on-demand, periodic
    DpdRetryInterval int
    • Range: 2-60
    NatKeepalive int
    Set NAT keepalive interval - Range: 5-3600
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    dpd Integer
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery String
    • Choices: on-demand, periodic
    dpdRetryInterval Integer
    • Range: 2-60
    natKeepalive Integer
    Set NAT keepalive interval - Range: 5-3600
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    dpd number
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery string
    • Choices: on-demand, periodic
    dpdRetryInterval number
    • Range: 2-60
    natKeepalive number
    Set NAT keepalive interval - Range: 5-3600
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    dpd_query str
    • Choices: on-demand, periodic
    dpd_retry_interval int
    • Range: 2-60
    nat_keepalive int
    Set NAT keepalive interval - Range: 5-3600
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    dpd Number
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery String
    • Choices: on-demand, periodic
    dpdRetryInterval Number
    • Range: 2-60
    natKeepalive Number
    Set NAT keepalive interval - Range: 5-3600

    Outputs

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

    Get an existing CryptoIkev2 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?: CryptoIkev2State, opts?: CustomResourceOptions): CryptoIkev2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            dpd: Optional[int] = None,
            dpd_query: Optional[str] = None,
            dpd_retry_interval: Optional[int] = None,
            nat_keepalive: Optional[int] = None) -> CryptoIkev2
    func GetCryptoIkev2(ctx *Context, name string, id IDInput, state *CryptoIkev2State, opts ...ResourceOption) (*CryptoIkev2, error)
    public static CryptoIkev2 Get(string name, Input<string> id, CryptoIkev2State? state, CustomResourceOptions? opts = null)
    public static CryptoIkev2 get(String name, Output<String> id, CryptoIkev2State 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:
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    DpdQuery string
    • Choices: on-demand, periodic
    DpdRetryInterval int
    • Range: 2-60
    NatKeepalive int
    Set NAT keepalive interval - Range: 5-3600
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    DpdQuery string
    • Choices: on-demand, periodic
    DpdRetryInterval int
    • Range: 2-60
    NatKeepalive int
    Set NAT keepalive interval - Range: 5-3600
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    dpd Integer
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery String
    • Choices: on-demand, periodic
    dpdRetryInterval Integer
    • Range: 2-60
    natKeepalive Integer
    Set NAT keepalive interval - Range: 5-3600
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    dpd number
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery string
    • Choices: on-demand, periodic
    dpdRetryInterval number
    • Range: 2-60
    natKeepalive number
    Set NAT keepalive interval - Range: 5-3600
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    dpd int
    Enable IKE liveness check for peers - Range: 10-3600
    dpd_query str
    • Choices: on-demand, periodic
    dpd_retry_interval int
    • Range: 2-60
    nat_keepalive int
    Set NAT keepalive interval - Range: 5-3600
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    dpd Number
    Enable IKE liveness check for peers - Range: 10-3600
    dpdQuery String
    • Choices: on-demand, periodic
    dpdRetryInterval Number
    • Range: 2-60
    natKeepalive Number
    Set NAT keepalive interval - Range: 5-3600

    Import

     $ pulumi import iosxe:index/cryptoIkev2:CryptoIkev2 example "Cisco-IOS-XE-native:native/crypto/Cisco-IOS-XE-crypto:ikev2"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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