1. Packages
  2. Juniper Mist
  3. API Docs
  4. site
  5. Psk
Juniper Mist v0.0.27 published on Friday, Sep 27, 2024 by Pulumi

junipermist.site.Psk

Explore with Pulumi AI

junipermist logo
Juniper Mist v0.0.27 published on Friday, Sep 27, 2024 by Pulumi

    This data source provides the list of Site PSKs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as junipermist from "@pulumi/juniper-mist";
    
    const pskOne = new junipermist.site.Psk("psk_one", {
        siteId: terraformSite.id,
        name: "JNP-FR-PAR",
        passphrase: "secretone",
        ssid: wlanOne.ssid,
        usage: "multi",
    });
    
    import pulumi
    import pulumi_juniper_mist as junipermist
    
    psk_one = junipermist.site.Psk("psk_one",
        site_id=terraform_site["id"],
        name="JNP-FR-PAR",
        passphrase="secretone",
        ssid=wlan_one["ssid"],
        usage="multi")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-junipermist/sdk/go/junipermist/site"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := site.NewPsk(ctx, "psk_one", &site.PskArgs{
    			SiteId:     pulumi.Any(terraformSite.Id),
    			Name:       pulumi.String("JNP-FR-PAR"),
    			Passphrase: pulumi.String("secretone"),
    			Ssid:       pulumi.Any(wlanOne.Ssid),
    			Usage:      pulumi.String("multi"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using JuniperMist = Pulumi.JuniperMist;
    
    return await Deployment.RunAsync(() => 
    {
        var pskOne = new JuniperMist.Site.Psk("psk_one", new()
        {
            SiteId = terraformSite.Id,
            Name = "JNP-FR-PAR",
            Passphrase = "secretone",
            Ssid = wlanOne.Ssid,
            Usage = "multi",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.site.Psk;
    import com.pulumi.junipermist.site.PskArgs;
    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 pskOne = new Psk("pskOne", PskArgs.builder()
                .siteId(terraformSite.id())
                .name("JNP-FR-PAR")
                .passphrase("secretone")
                .ssid(wlanOne.ssid())
                .usage("multi")
                .build());
    
        }
    }
    
    resources:
      pskOne:
        type: junipermist:site:Psk
        name: psk_one
        properties:
          siteId: ${terraformSite.id}
          name: JNP-FR-PAR
          passphrase: secretone
          ssid: ${wlanOne.ssid}
          usage: multi
    

    Create Psk Resource

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

    Constructor syntax

    new Psk(name: string, args: PskArgs, opts?: CustomResourceOptions);
    @overload
    def Psk(resource_name: str,
            args: PskArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Psk(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            passphrase: Optional[str] = None,
            ssid: Optional[str] = None,
            site_id: Optional[str] = None,
            mac: Optional[str] = None,
            name: Optional[str] = None,
            note: Optional[str] = None,
            notify_expiry: Optional[bool] = None,
            notify_on_create_or_edit: Optional[bool] = None,
            old_passphrase: Optional[str] = None,
            email: Optional[str] = None,
            role: Optional[str] = None,
            expiry_notification_time: Optional[int] = None,
            expire_time: Optional[int] = None,
            usage: Optional[str] = None,
            vlan_id: Optional[str] = None)
    func NewPsk(ctx *Context, name string, args PskArgs, opts ...ResourceOption) (*Psk, error)
    public Psk(string name, PskArgs args, CustomResourceOptions? opts = null)
    public Psk(String name, PskArgs args)
    public Psk(String name, PskArgs args, CustomResourceOptions options)
    
    type: junipermist:site:Psk
    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 PskArgs
    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 PskArgs
    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 PskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var junipermistPskResource = new JuniperMist.Site.Psk("junipermistPskResource", new()
    {
        Passphrase = "string",
        Ssid = "string",
        SiteId = "string",
        Mac = "string",
        Name = "string",
        Note = "string",
        NotifyExpiry = false,
        NotifyOnCreateOrEdit = false,
        OldPassphrase = "string",
        Email = "string",
        Role = "string",
        ExpiryNotificationTime = 0,
        ExpireTime = 0,
        Usage = "string",
        VlanId = "string",
    });
    
    example, err := site.NewPsk(ctx, "junipermistPskResource", &site.PskArgs{
    	Passphrase:             pulumi.String("string"),
    	Ssid:                   pulumi.String("string"),
    	SiteId:                 pulumi.String("string"),
    	Mac:                    pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	Note:                   pulumi.String("string"),
    	NotifyExpiry:           pulumi.Bool(false),
    	NotifyOnCreateOrEdit:   pulumi.Bool(false),
    	OldPassphrase:          pulumi.String("string"),
    	Email:                  pulumi.String("string"),
    	Role:                   pulumi.String("string"),
    	ExpiryNotificationTime: pulumi.Int(0),
    	ExpireTime:             pulumi.Int(0),
    	Usage:                  pulumi.String("string"),
    	VlanId:                 pulumi.String("string"),
    })
    
    var junipermistPskResource = new Psk("junipermistPskResource", PskArgs.builder()
        .passphrase("string")
        .ssid("string")
        .siteId("string")
        .mac("string")
        .name("string")
        .note("string")
        .notifyExpiry(false)
        .notifyOnCreateOrEdit(false)
        .oldPassphrase("string")
        .email("string")
        .role("string")
        .expiryNotificationTime(0)
        .expireTime(0)
        .usage("string")
        .vlanId("string")
        .build());
    
    junipermist_psk_resource = junipermist.site.Psk("junipermistPskResource",
        passphrase="string",
        ssid="string",
        site_id="string",
        mac="string",
        name="string",
        note="string",
        notify_expiry=False,
        notify_on_create_or_edit=False,
        old_passphrase="string",
        email="string",
        role="string",
        expiry_notification_time=0,
        expire_time=0,
        usage="string",
        vlan_id="string")
    
    const junipermistPskResource = new junipermist.site.Psk("junipermistPskResource", {
        passphrase: "string",
        ssid: "string",
        siteId: "string",
        mac: "string",
        name: "string",
        note: "string",
        notifyExpiry: false,
        notifyOnCreateOrEdit: false,
        oldPassphrase: "string",
        email: "string",
        role: "string",
        expiryNotificationTime: 0,
        expireTime: 0,
        usage: "string",
        vlanId: "string",
    });
    
    type: junipermist:site:Psk
    properties:
        email: string
        expireTime: 0
        expiryNotificationTime: 0
        mac: string
        name: string
        note: string
        notifyExpiry: false
        notifyOnCreateOrEdit: false
        oldPassphrase: string
        passphrase: string
        role: string
        siteId: string
        ssid: string
        usage: string
        vlanId: string
    

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

    Passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    SiteId string
    Ssid string
    SSID this PSK should be applicable to
    Email string
    email to send psk expiring notifications to
    ExpireTime int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    ExpiryNotificationTime int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    Name string
    Note string
    NotifyExpiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    NotifyOnCreateOrEdit bool
    If set to true, notification will be sent when psk is created or edited
    OldPassphrase string
    previous passphrase of the PSK if it has been rotated
    Role string
    Usage string
    enum: multi, single
    VlanId string
    Passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    SiteId string
    Ssid string
    SSID this PSK should be applicable to
    Email string
    email to send psk expiring notifications to
    ExpireTime int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    ExpiryNotificationTime int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    Name string
    Note string
    NotifyExpiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    NotifyOnCreateOrEdit bool
    If set to true, notification will be sent when psk is created or edited
    OldPassphrase string
    previous passphrase of the PSK if it has been rotated
    Role string
    Usage string
    enum: multi, single
    VlanId string
    passphrase String
    passphrase of the PSK (8-63 character or 64 in hex)
    siteId String
    ssid String
    SSID this PSK should be applicable to
    email String
    email to send psk expiring notifications to
    expireTime Integer
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime Integer
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name String
    note String
    notifyExpiry Boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit Boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase String
    previous passphrase of the PSK if it has been rotated
    role String
    usage String
    enum: multi, single
    vlanId String
    passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    siteId string
    ssid string
    SSID this PSK should be applicable to
    email string
    email to send psk expiring notifications to
    expireTime number
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime number
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name string
    note string
    notifyExpiry boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase string
    previous passphrase of the PSK if it has been rotated
    role string
    usage string
    enum: multi, single
    vlanId string
    passphrase str
    passphrase of the PSK (8-63 character or 64 in hex)
    site_id str
    ssid str
    SSID this PSK should be applicable to
    email str
    email to send psk expiring notifications to
    expire_time int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiry_notification_time int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac str
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name str
    note str
    notify_expiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    notify_on_create_or_edit bool
    If set to true, notification will be sent when psk is created or edited
    old_passphrase str
    previous passphrase of the PSK if it has been rotated
    role str
    usage str
    enum: multi, single
    vlan_id str
    passphrase String
    passphrase of the PSK (8-63 character or 64 in hex)
    siteId String
    ssid String
    SSID this PSK should be applicable to
    email String
    email to send psk expiring notifications to
    expireTime Number
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime Number
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name String
    note String
    notifyExpiry Boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit Boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase String
    previous passphrase of the PSK if it has been rotated
    role String
    usage String
    enum: multi, single
    vlanId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Psk resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String

    Look up Existing Psk Resource

    Get an existing Psk 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?: PskState, opts?: CustomResourceOptions): Psk
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            expire_time: Optional[int] = None,
            expiry_notification_time: Optional[int] = None,
            mac: Optional[str] = None,
            name: Optional[str] = None,
            note: Optional[str] = None,
            notify_expiry: Optional[bool] = None,
            notify_on_create_or_edit: Optional[bool] = None,
            old_passphrase: Optional[str] = None,
            org_id: Optional[str] = None,
            passphrase: Optional[str] = None,
            role: Optional[str] = None,
            site_id: Optional[str] = None,
            ssid: Optional[str] = None,
            usage: Optional[str] = None,
            vlan_id: Optional[str] = None) -> Psk
    func GetPsk(ctx *Context, name string, id IDInput, state *PskState, opts ...ResourceOption) (*Psk, error)
    public static Psk Get(string name, Input<string> id, PskState? state, CustomResourceOptions? opts = null)
    public static Psk get(String name, Output<String> id, PskState 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:
    Email string
    email to send psk expiring notifications to
    ExpireTime int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    ExpiryNotificationTime int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    Name string
    Note string
    NotifyExpiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    NotifyOnCreateOrEdit bool
    If set to true, notification will be sent when psk is created or edited
    OldPassphrase string
    previous passphrase of the PSK if it has been rotated
    OrgId string
    Passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    Role string
    SiteId string
    Ssid string
    SSID this PSK should be applicable to
    Usage string
    enum: multi, single
    VlanId string
    Email string
    email to send psk expiring notifications to
    ExpireTime int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    ExpiryNotificationTime int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    Name string
    Note string
    NotifyExpiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    NotifyOnCreateOrEdit bool
    If set to true, notification will be sent when psk is created or edited
    OldPassphrase string
    previous passphrase of the PSK if it has been rotated
    OrgId string
    Passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    Role string
    SiteId string
    Ssid string
    SSID this PSK should be applicable to
    Usage string
    enum: multi, single
    VlanId string
    email String
    email to send psk expiring notifications to
    expireTime Integer
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime Integer
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name String
    note String
    notifyExpiry Boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit Boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase String
    previous passphrase of the PSK if it has been rotated
    orgId String
    passphrase String
    passphrase of the PSK (8-63 character or 64 in hex)
    role String
    siteId String
    ssid String
    SSID this PSK should be applicable to
    usage String
    enum: multi, single
    vlanId String
    email string
    email to send psk expiring notifications to
    expireTime number
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime number
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name string
    note string
    notifyExpiry boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase string
    previous passphrase of the PSK if it has been rotated
    orgId string
    passphrase string
    passphrase of the PSK (8-63 character or 64 in hex)
    role string
    siteId string
    ssid string
    SSID this PSK should be applicable to
    usage string
    enum: multi, single
    vlanId string
    email str
    email to send psk expiring notifications to
    expire_time int
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiry_notification_time int
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac str
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name str
    note str
    notify_expiry bool
    If set to true, reminder notification will be sent when psk is about to expire
    notify_on_create_or_edit bool
    If set to true, notification will be sent when psk is created or edited
    old_passphrase str
    previous passphrase of the PSK if it has been rotated
    org_id str
    passphrase str
    passphrase of the PSK (8-63 character or 64 in hex)
    role str
    site_id str
    ssid str
    SSID this PSK should be applicable to
    usage str
    enum: multi, single
    vlan_id str
    email String
    email to send psk expiring notifications to
    expireTime Number
    Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
    expiryNotificationTime Number
    Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    name String
    note String
    notifyExpiry Boolean
    If set to true, reminder notification will be sent when psk is about to expire
    notifyOnCreateOrEdit Boolean
    If set to true, notification will be sent when psk is created or edited
    oldPassphrase String
    previous passphrase of the PSK if it has been rotated
    orgId String
    passphrase String
    passphrase of the PSK (8-63 character or 64 in hex)
    role String
    siteId String
    ssid String
    SSID this PSK should be applicable to
    usage String
    enum: multi, single
    vlanId String

    Import

    Using pulumi import, import mist_site_psk with:

    Site PSK can be imported by specifying the site_id and the psk_id

    $ pulumi import junipermist:site/psk:Psk psk_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
    

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

    Package Details

    Repository
    junipermist pulumi/pulumi-junipermist
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mist Terraform Provider.
    junipermist logo
    Juniper Mist v0.0.27 published on Friday, Sep 27, 2024 by Pulumi