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

iosxe.CryptoIkev2Keyring

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 Keyring configuration.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.CryptoIkev2Keyring;
    import com.pulumi.iosxe.CryptoIkev2KeyringArgs;
    import com.pulumi.iosxe.inputs.CryptoIkev2KeyringPeerArgs;
    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 CryptoIkev2Keyring("example", CryptoIkev2KeyringArgs.builder()        
                .peers(CryptoIkev2KeyringPeerArgs.builder()
                    .description("My description")
                    .identity_key_id("key1")
                    .ipv4_address("1.2.3.4")
                    .ipv4_mask("255.255.255.248")
                    .name("peer1")
                    .pre_shared_key_local("cisco123")
                    .pre_shared_key_local_encryption("6")
                    .pre_shared_key_remote("cisco123")
                    .pre_shared_key_remote_encryption("6")
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:CryptoIkev2Keyring
        properties:
          peers:
            - description: My description
              identity_key_id: key1
              ipv4_address: 1.2.3.4
              ipv4_mask: 255.255.255.248
              name: peer1
              pre_shared_key_local: cisco123
              pre_shared_key_local_encryption: '6'
              pre_shared_key_remote: cisco123
              pre_shared_key_remote_encryption: '6'
    

    Create CryptoIkev2Keyring Resource

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

    Constructor syntax

    new CryptoIkev2Keyring(name: string, args?: CryptoIkev2KeyringArgs, opts?: CustomResourceOptions);
    @overload
    def CryptoIkev2Keyring(resource_name: str,
                           args: Optional[CryptoIkev2KeyringArgs] = None,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def CryptoIkev2Keyring(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           device: Optional[str] = None,
                           name: Optional[str] = None,
                           peers: Optional[Sequence[CryptoIkev2KeyringPeerArgs]] = None)
    func NewCryptoIkev2Keyring(ctx *Context, name string, args *CryptoIkev2KeyringArgs, opts ...ResourceOption) (*CryptoIkev2Keyring, error)
    public CryptoIkev2Keyring(string name, CryptoIkev2KeyringArgs? args = null, CustomResourceOptions? opts = null)
    public CryptoIkev2Keyring(String name, CryptoIkev2KeyringArgs args)
    public CryptoIkev2Keyring(String name, CryptoIkev2KeyringArgs args, CustomResourceOptions options)
    
    type: iosxe:CryptoIkev2Keyring
    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 CryptoIkev2KeyringArgs
    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 CryptoIkev2KeyringArgs
    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 CryptoIkev2KeyringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CryptoIkev2KeyringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CryptoIkev2KeyringArgs
    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 cryptoIkev2KeyringResource = new Iosxe.CryptoIkev2Keyring("cryptoIkev2KeyringResource", new()
    {
        Device = "string",
        Name = "string",
        Peers = new[]
        {
            new Iosxe.Inputs.CryptoIkev2KeyringPeerArgs
            {
                Name = "string",
                Ipv4Address = "string",
                IdentityFqdnDomain = "string",
                Ipv4Mask = "string",
                IdentityEmailName = "string",
                Ipv6Prefix = "string",
                IdentityFqdnName = "string",
                IdentityKeyId = "string",
                Hostname = "string",
                IdentityEmailDomain = "string",
                IdentityAddress = "string",
                Description = "string",
                PreSharedKey = "string",
                PreSharedKeyEncryption = "string",
                PreSharedKeyLocal = "string",
                PreSharedKeyLocalEncryption = "string",
                PreSharedKeyRemote = "string",
                PreSharedKeyRemoteEncryption = "string",
            },
        },
    });
    
    example, err := iosxe.NewCryptoIkev2Keyring(ctx, "cryptoIkev2KeyringResource", &iosxe.CryptoIkev2KeyringArgs{
    	Device: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	Peers: iosxe.CryptoIkev2KeyringPeerArray{
    		&iosxe.CryptoIkev2KeyringPeerArgs{
    			Name:                         pulumi.String("string"),
    			Ipv4Address:                  pulumi.String("string"),
    			IdentityFqdnDomain:           pulumi.String("string"),
    			Ipv4Mask:                     pulumi.String("string"),
    			IdentityEmailName:            pulumi.String("string"),
    			Ipv6Prefix:                   pulumi.String("string"),
    			IdentityFqdnName:             pulumi.String("string"),
    			IdentityKeyId:                pulumi.String("string"),
    			Hostname:                     pulumi.String("string"),
    			IdentityEmailDomain:          pulumi.String("string"),
    			IdentityAddress:              pulumi.String("string"),
    			Description:                  pulumi.String("string"),
    			PreSharedKey:                 pulumi.String("string"),
    			PreSharedKeyEncryption:       pulumi.String("string"),
    			PreSharedKeyLocal:            pulumi.String("string"),
    			PreSharedKeyLocalEncryption:  pulumi.String("string"),
    			PreSharedKeyRemote:           pulumi.String("string"),
    			PreSharedKeyRemoteEncryption: pulumi.String("string"),
    		},
    	},
    })
    
    var cryptoIkev2KeyringResource = new CryptoIkev2Keyring("cryptoIkev2KeyringResource", CryptoIkev2KeyringArgs.builder()        
        .device("string")
        .name("string")
        .peers(CryptoIkev2KeyringPeerArgs.builder()
            .name("string")
            .ipv4Address("string")
            .identityFqdnDomain("string")
            .ipv4Mask("string")
            .identityEmailName("string")
            .ipv6Prefix("string")
            .identityFqdnName("string")
            .identityKeyId("string")
            .hostname("string")
            .identityEmailDomain("string")
            .identityAddress("string")
            .description("string")
            .preSharedKey("string")
            .preSharedKeyEncryption("string")
            .preSharedKeyLocal("string")
            .preSharedKeyLocalEncryption("string")
            .preSharedKeyRemote("string")
            .preSharedKeyRemoteEncryption("string")
            .build())
        .build());
    
    crypto_ikev2_keyring_resource = iosxe.CryptoIkev2Keyring("cryptoIkev2KeyringResource",
        device="string",
        name="string",
        peers=[iosxe.CryptoIkev2KeyringPeerArgs(
            name="string",
            ipv4_address="string",
            identity_fqdn_domain="string",
            ipv4_mask="string",
            identity_email_name="string",
            ipv6_prefix="string",
            identity_fqdn_name="string",
            identity_key_id="string",
            hostname="string",
            identity_email_domain="string",
            identity_address="string",
            description="string",
            pre_shared_key="string",
            pre_shared_key_encryption="string",
            pre_shared_key_local="string",
            pre_shared_key_local_encryption="string",
            pre_shared_key_remote="string",
            pre_shared_key_remote_encryption="string",
        )])
    
    const cryptoIkev2KeyringResource = new iosxe.CryptoIkev2Keyring("cryptoIkev2KeyringResource", {
        device: "string",
        name: "string",
        peers: [{
            name: "string",
            ipv4Address: "string",
            identityFqdnDomain: "string",
            ipv4Mask: "string",
            identityEmailName: "string",
            ipv6Prefix: "string",
            identityFqdnName: "string",
            identityKeyId: "string",
            hostname: "string",
            identityEmailDomain: "string",
            identityAddress: "string",
            description: "string",
            preSharedKey: "string",
            preSharedKeyEncryption: "string",
            preSharedKeyLocal: "string",
            preSharedKeyLocalEncryption: "string",
            preSharedKeyRemote: "string",
            preSharedKeyRemoteEncryption: "string",
        }],
    });
    
    type: iosxe:CryptoIkev2Keyring
    properties:
        device: string
        name: string
        peers:
            - description: string
              hostname: string
              identityAddress: string
              identityEmailDomain: string
              identityEmailName: string
              identityFqdnDomain: string
              identityFqdnName: string
              identityKeyId: string
              ipv4Address: string
              ipv4Mask: string
              ipv6Prefix: string
              name: string
              preSharedKey: string
              preSharedKeyEncryption: string
              preSharedKeyLocal: string
              preSharedKeyLocalEncryption: string
              preSharedKeyRemote: string
              preSharedKeyRemoteEncryption: string
    

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

    Device string
    A device name from the provider configuration.
    Name string
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.CryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    Device string
    A device name from the provider configuration.
    Name string
    Peers []CryptoIkev2KeyringPeerArgs
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.
    name String
    peers List<CryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    device string
    A device name from the provider configuration.
    name string
    peers CryptoIkev2KeyringPeer[]
    Configure a Peer and associated keys
    device str
    A device name from the provider configuration.
    name str
    peers Sequence[CryptoIkev2KeyringPeerArgs]
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.
    name String
    peers List<Property Map>
    Configure a Peer and associated keys

    Outputs

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

    Get an existing CryptoIkev2Keyring 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?: CryptoIkev2KeyringState, opts?: CustomResourceOptions): CryptoIkev2Keyring
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            name: Optional[str] = None,
            peers: Optional[Sequence[CryptoIkev2KeyringPeerArgs]] = None) -> CryptoIkev2Keyring
    func GetCryptoIkev2Keyring(ctx *Context, name string, id IDInput, state *CryptoIkev2KeyringState, opts ...ResourceOption) (*CryptoIkev2Keyring, error)
    public static CryptoIkev2Keyring Get(string name, Input<string> id, CryptoIkev2KeyringState? state, CustomResourceOptions? opts = null)
    public static CryptoIkev2Keyring get(String name, Output<String> id, CryptoIkev2KeyringState 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.
    Name string
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.CryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    Device string
    A device name from the provider configuration.
    Name string
    Peers []CryptoIkev2KeyringPeerArgs
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.
    name String
    peers List<CryptoIkev2KeyringPeer>
    Configure a Peer and associated keys
    device string
    A device name from the provider configuration.
    name string
    peers CryptoIkev2KeyringPeer[]
    Configure a Peer and associated keys
    device str
    A device name from the provider configuration.
    name str
    peers Sequence[CryptoIkev2KeyringPeerArgs]
    Configure a Peer and associated keys
    device String
    A device name from the provider configuration.
    name String
    peers List<Property Map>
    Configure a Peer and associated keys

    Supporting Types

    CryptoIkev2KeyringPeer, CryptoIkev2KeyringPeerArgs

    Name 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
    PreSharedKey string
    PreSharedKeyEncryption string
    • Choices: 0, 6
    PreSharedKeyLocal string
    PreSharedKeyLocalEncryption string
    • Choices: 0, 6
    PreSharedKeyRemote string
    PreSharedKeyRemoteEncryption string
    • Choices: 0, 6
    Name 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
    PreSharedKey string
    PreSharedKeyEncryption string
    • Choices: 0, 6
    PreSharedKeyLocal string
    PreSharedKeyLocalEncryption string
    • Choices: 0, 6
    PreSharedKeyRemote string
    PreSharedKeyRemoteEncryption string
    • Choices: 0, 6
    name 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
    preSharedKey String
    preSharedKeyEncryption String
    • Choices: 0, 6
    preSharedKeyLocal String
    preSharedKeyLocalEncryption String
    • Choices: 0, 6
    preSharedKeyRemote String
    preSharedKeyRemoteEncryption String
    • Choices: 0, 6
    name 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
    preSharedKey string
    preSharedKeyEncryption string
    • Choices: 0, 6
    preSharedKeyLocal string
    preSharedKeyLocalEncryption string
    • Choices: 0, 6
    preSharedKeyRemote string
    preSharedKeyRemoteEncryption string
    • Choices: 0, 6
    name str
    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
    pre_shared_key str
    pre_shared_key_encryption str
    • Choices: 0, 6
    pre_shared_key_local str
    pre_shared_key_local_encryption str
    • Choices: 0, 6
    pre_shared_key_remote str
    pre_shared_key_remote_encryption str
    • Choices: 0, 6
    name 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
    preSharedKey String
    preSharedKeyEncryption String
    • Choices: 0, 6
    preSharedKeyLocal String
    preSharedKeyLocalEncryption String
    • Choices: 0, 6
    preSharedKeyRemote String
    preSharedKeyRemoteEncryption String
    • Choices: 0, 6

    Import

     $ pulumi import iosxe:index/cryptoIkev2Keyring:CryptoIkev2Keyring example "Cisco-IOS-XE-native:native/crypto/Cisco-IOS-XE-crypto:ikev2/keyring=keyring1"
    

    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