1. Packages
  2. Juniper Mist Provider
  3. API Docs
  4. site
  5. getPsks
Juniper Mist v0.2.4 published on Saturday, Mar 1, 2025 by Pulumi

junipermist.site.getPsks

Explore with Pulumi AI

junipermist logo
Juniper Mist v0.2.4 published on Saturday, Mar 1, 2025 by Pulumi

    This data source provides the list of Site Psks.

    A multi PSK (Pre-Shared Key) is a feature that allows the use of multiple PSKs for securing network connections.
    It provides a simple and comprehensive way to onboard client devices without relying on client mac addresses.
    Each psk has its own key name, which can be used for user-level accountability, key rotation, and visibility in the management platform. It supports the creation, rotation, and auto-expiration of psks, and allows vlan assignment and role assignment for dynamic per-user policies.
    Multi PSKs create virtual broadcast domains and can be used for end-user onboarding via authenticated sso login.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as junipermist from "@pulumi/junipermist";
    
    const psksVip = junipermist.site.getPsks({
        siteId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
        name: "psk_one",
        role: "vip",
        ssid: "psk_ssid",
    });
    
    import pulumi
    import pulumi_junipermist as junipermist
    
    psks_vip = junipermist.site.get_psks(site_id="15fca2ac-b1a6-47cc-9953-cc6906281550",
        name="psk_one",
        role="vip",
        ssid="psk_ssid")
    
    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.GetPsks(ctx, &site.GetPsksArgs{
    			SiteId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
    			Name:   pulumi.StringRef("psk_one"),
    			Role:   pulumi.StringRef("vip"),
    			Ssid:   pulumi.StringRef("psk_ssid"),
    		}, nil)
    		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 psksVip = JuniperMist.Site.GetPsks.Invoke(new()
        {
            SiteId = "15fca2ac-b1a6-47cc-9953-cc6906281550",
            Name = "psk_one",
            Role = "vip",
            Ssid = "psk_ssid",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.site.SiteFunctions;
    import com.pulumi.junipermist.site.inputs.GetPsksArgs;
    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 psksVip = SiteFunctions.getPsks(GetPsksArgs.builder()
                .siteId("15fca2ac-b1a6-47cc-9953-cc6906281550")
                .name("psk_one")
                .role("vip")
                .ssid("psk_ssid")
                .build());
    
        }
    }
    
    variables:
      psksVip:
        fn::invoke:
          function: junipermist:site:getPsks
          arguments:
            siteId: 15fca2ac-b1a6-47cc-9953-cc6906281550
            name: psk_one
            role: vip
            ssid: psk_ssid
    

    Using getPsks

    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 getPsks(args: GetPsksArgs, opts?: InvokeOptions): Promise<GetPsksResult>
    function getPsksOutput(args: GetPsksOutputArgs, opts?: InvokeOptions): Output<GetPsksResult>
    def get_psks(name: Optional[str] = None,
                 role: Optional[str] = None,
                 site_id: Optional[str] = None,
                 ssid: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPsksResult
    def get_psks_output(name: Optional[pulumi.Input[str]] = None,
                 role: Optional[pulumi.Input[str]] = None,
                 site_id: Optional[pulumi.Input[str]] = None,
                 ssid: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPsksResult]
    func GetPsks(ctx *Context, args *GetPsksArgs, opts ...InvokeOption) (*GetPsksResult, error)
    func GetPsksOutput(ctx *Context, args *GetPsksOutputArgs, opts ...InvokeOption) GetPsksResultOutput

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

    public static class GetPsks 
    {
        public static Task<GetPsksResult> InvokeAsync(GetPsksArgs args, InvokeOptions? opts = null)
        public static Output<GetPsksResult> Invoke(GetPsksInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPsksResult> getPsks(GetPsksArgs args, InvokeOptions options)
    public static Output<GetPsksResult> getPsks(GetPsksArgs args, InvokeOptions options)
    
    fn::invoke:
      function: junipermist:site/getPsks:getPsks
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SiteId string
    Name string
    Role string
    Ssid string
    SiteId string
    Name string
    Role string
    Ssid string
    siteId String
    name String
    role String
    ssid String
    siteId string
    name string
    role string
    ssid string
    site_id str
    name str
    role str
    ssid str
    siteId String
    name String
    role String
    ssid String

    getPsks Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId string
    SitePsks List<Pulumi.JuniperMist.Site.Outputs.GetPsksSitePsk>
    Name string
    Role string
    Ssid string
    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId string
    SitePsks []GetPsksSitePsk
    Name string
    Role string
    Ssid string
    id String
    The provider-assigned unique ID for this managed resource.
    siteId String
    sitePsks List<GetPsksSitePsk>
    name String
    role String
    ssid String
    id string
    The provider-assigned unique ID for this managed resource.
    siteId string
    sitePsks GetPsksSitePsk[]
    name string
    role string
    ssid string
    id str
    The provider-assigned unique ID for this managed resource.
    site_id str
    site_psks Sequence[GetPsksSitePsk]
    name str
    role str
    ssid str
    id String
    The provider-assigned unique ID for this managed resource.
    siteId String
    sitePsks List<Property Map>
    name String
    role String
    ssid String

    Supporting Types

    GetPsksSitePsk

    AdminSsoId string
    sso id for psk created from psk portal
    CreatedTime double
    when the object has been created, in epoch
    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
    Id string
    Unique ID of the object instance in the Mist Organnization
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    ModifiedTime double
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    VlanId string
    AdminSsoId string
    sso id for psk created from psk portal
    CreatedTime float64
    when the object has been created, in epoch
    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
    Id string
    Unique ID of the object instance in the Mist Organnization
    Mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    ModifiedTime float64
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    VlanId string
    adminSsoId String
    sso id for psk created from psk portal
    createdTime Double
    when the object has been created, in epoch
    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
    id String
    Unique ID of the object instance in the Mist Organnization
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    modifiedTime Double
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    vlanId String
    adminSsoId string
    sso id for psk created from psk portal
    createdTime number
    when the object has been created, in epoch
    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
    id string
    Unique ID of the object instance in the Mist Organnization
    mac string
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    modifiedTime number
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    vlanId string
    admin_sso_id str
    sso id for psk created from psk portal
    created_time float
    when the object has been created, in epoch
    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
    id str
    Unique ID of the object instance in the Mist Organnization
    mac str
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    modified_time float
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    vlan_id str
    adminSsoId String
    sso id for psk created from psk portal
    createdTime Number
    when the object has been created, in epoch
    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
    id String
    Unique ID of the object instance in the Mist Organnization
    mac String
    if usage==single, the mac that this PSK ties to, empty if auto-binding
    modifiedTime Number
    when the object has been modified for the last time, in epoch
    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: macs, multi, single
    vlanId String

    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.2.4 published on Saturday, Mar 1, 2025 by Pulumi