Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Juniper Mist
  3. API Docs
  4. site
  5. WlanPortalImage
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi
pulumi/pulumi-junipermist

junipermist.site.WlanPortalImage

Explore with Pulumi AI

junipermist logo
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi
pulumi/pulumi-junipermist

    This resource is used to upload a WLAN Captive Web Portal background image. The WLAN object contains all the required configuration to broadcast an SSID (Authentication, VLAN, …)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as junipermist from "@pulumi/juniper-mist";

const wlanOne = new junipermist.site.WlanPortalImage("wlan_one", {
    siteId: terraformTest.id,
    wlanId: wlanOneMistSiteWlan.id,
    file: "/Users/johndoe/Documents/image.jpg",
});

    import pulumi
import pulumi_juniper_mist as junipermist

wlan_one = junipermist.site.WlanPortalImage("wlan_one",
    site_id=terraform_test["id"],
    wlan_id=wlan_one_mist_site_wlan["id"],
    file="/Users/johndoe/Documents/image.jpg")

    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.NewWlanPortalImage(ctx, "wlan_one", &site.WlanPortalImageArgs{
			SiteId: pulumi.Any(terraformTest.Id),
			WlanId: pulumi.Any(wlanOneMistSiteWlan.Id),
			File:   pulumi.String("/Users/johndoe/Documents/image.jpg"),
		})
		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 wlanOne = new JuniperMist.Site.WlanPortalImage("wlan_one", new()
    {
        SiteId = terraformTest.Id,
        WlanId = wlanOneMistSiteWlan.Id,
        File = "/Users/johndoe/Documents/image.jpg",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.junipermist.site.WlanPortalImage;
import com.pulumi.junipermist.site.WlanPortalImageArgs;
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 wlanOne = new WlanPortalImage("wlanOne", WlanPortalImageArgs.builder()
            .siteId(terraformTest.id())
            .wlanId(wlanOneMistSiteWlan.id())
            .file("/Users/johndoe/Documents/image.jpg")
            .build());

    }
}

    resources:
  wlanOne:
    type: junipermist:site:WlanPortalImage
    name: wlan_one
    properties:
      siteId: ${terraformTest.id}
      wlanId: ${wlanOneMistSiteWlan.id}
      file: /Users/johndoe/Documents/image.jpg

    Create WlanPortalImage Resource

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

    Constructor syntax

    new WlanPortalImage(name: string, args: WlanPortalImageArgs, opts?: CustomResourceOptions);
    @overload
def WlanPortalImage(resource_name: str,
                    args: WlanPortalImageArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def WlanPortalImage(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    file: Optional[str] = None,
                    site_id: Optional[str] = None,
                    wlan_id: Optional[str] = None)
    func NewWlanPortalImage(ctx *Context, name string, args WlanPortalImageArgs, opts ...ResourceOption) (*WlanPortalImage, error)
    public WlanPortalImage(string name, WlanPortalImageArgs args, CustomResourceOptions? opts = null)
    public WlanPortalImage(String name, WlanPortalImageArgs args)
public WlanPortalImage(String name, WlanPortalImageArgs args, CustomResourceOptions options)

    type: junipermist:site:WlanPortalImage
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 WlanPortalImageArgs
    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 WlanPortalImageArgs
    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 WlanPortalImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WlanPortalImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WlanPortalImageArgs
    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 junipermistWlanPortalImageResource = new JuniperMist.Site.WlanPortalImage("junipermistWlanPortalImageResource", new()
{
    File = "string",
    SiteId = "string",
    WlanId = "string",
});

    example, err := site.NewWlanPortalImage(ctx, "junipermistWlanPortalImageResource", &site.WlanPortalImageArgs{
	File:   pulumi.String("string"),
	SiteId: pulumi.String("string"),
	WlanId: pulumi.String("string"),
})

    var junipermistWlanPortalImageResource = new WlanPortalImage("junipermistWlanPortalImageResource", WlanPortalImageArgs.builder()
    .file("string")
    .siteId("string")
    .wlanId("string")
    .build());

    junipermist_wlan_portal_image_resource = junipermist.site.WlanPortalImage("junipermistWlanPortalImageResource",
    file="string",
    site_id="string",
    wlan_id="string")

    const junipermistWlanPortalImageResource = new junipermist.site.WlanPortalImage("junipermistWlanPortalImageResource", {
    file: "string",
    siteId: "string",
    wlanId: "string",
});

    type: junipermist:site:WlanPortalImage
properties:
    file: string
    siteId: string
    wlanId: string

    WlanPortalImage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WlanPortalImage resource accepts the following input properties:

    File string
    path to the background image file. File must be a jpeg, jpg or png image`
    SiteId string
    WlanId string
    Site WLAN ID
    File string
    path to the background image file. File must be a jpeg, jpg or png image`
    SiteId string
    WlanId string
    Site WLAN ID
    file String
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId String
    wlanId String
    Site WLAN ID
    file string
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId string
    wlanId string
    Site WLAN ID
    file str
    path to the background image file. File must be a jpeg, jpg or png image`
    site_id str
    wlan_id str
    Site WLAN ID
    file String
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId String
    wlanId String
    Site WLAN ID

    Outputs

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

    Get an existing WlanPortalImage 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?: WlanPortalImageState, opts?: CustomResourceOptions): WlanPortalImage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        file: Optional[str] = None,
        site_id: Optional[str] = None,
        wlan_id: Optional[str] = None) -> WlanPortalImage
    func GetWlanPortalImage(ctx *Context, name string, id IDInput, state *WlanPortalImageState, opts ...ResourceOption) (*WlanPortalImage, error)
    public static WlanPortalImage Get(string name, Input<string> id, WlanPortalImageState? state, CustomResourceOptions? opts = null)
    public static WlanPortalImage get(String name, Output<String> id, WlanPortalImageState 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:
    File string
    path to the background image file. File must be a jpeg, jpg or png image`
    SiteId string
    WlanId string
    Site WLAN ID
    File string
    path to the background image file. File must be a jpeg, jpg or png image`
    SiteId string
    WlanId string
    Site WLAN ID
    file String
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId String
    wlanId String
    Site WLAN ID
    file string
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId string
    wlanId string
    Site WLAN ID
    file str
    path to the background image file. File must be a jpeg, jpg or png image`
    site_id str
    wlan_id str
    Site WLAN ID
    file String
    path to the background image file. File must be a jpeg, jpg or png image`
    siteId String
    wlanId String
    Site WLAN ID

    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.1.1 published on Monday, Nov 4, 2024 by Pulumi
    pulumi/pulumi-junipermist