1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. organizations
  5. Licenses
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.organizations.Licenses

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = new meraki.organizations.Licenses("example", {
    deviceSerial: "Q234-ABCD-5678",
    licenseId: "string",
    organizationId: "string",
});
export const merakiOrganizationsLicensesExample = example;
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.Licenses("example",
    device_serial="Q234-ABCD-5678",
    license_id="string",
    organization_id="string")
pulumi.export("merakiOrganizationsLicensesExample", example)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := organizations.NewLicenses(ctx, "example", &organizations.LicensesArgs{
			DeviceSerial:   pulumi.String("Q234-ABCD-5678"),
			LicenseId:      pulumi.String("string"),
			OrganizationId: pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsLicensesExample", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Organizations.Licenses("example", new()
    {
        DeviceSerial = "Q234-ABCD-5678",
        LicenseId = "string",
        OrganizationId = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsLicensesExample"] = example,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.Licenses;
import com.pulumi.meraki.organizations.LicensesArgs;
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 Licenses("example", LicensesArgs.builder()
            .deviceSerial("Q234-ABCD-5678")
            .licenseId("string")
            .organizationId("string")
            .build());

        ctx.export("merakiOrganizationsLicensesExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:organizations:Licenses
    properties:
      deviceSerial: Q234-ABCD-5678
      licenseId: string
      organizationId: string
outputs:
  merakiOrganizationsLicensesExample: ${example}
Copy

Create Licenses Resource

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

Constructor syntax

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

@overload
def Licenses(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             license_id: Optional[str] = None,
             organization_id: Optional[str] = None,
             device_serial: Optional[str] = None)
func NewLicenses(ctx *Context, name string, args LicensesArgs, opts ...ResourceOption) (*Licenses, error)
public Licenses(string name, LicensesArgs args, CustomResourceOptions? opts = null)
public Licenses(String name, LicensesArgs args)
public Licenses(String name, LicensesArgs args, CustomResourceOptions options)
type: meraki:organizations:Licenses
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LicensesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LicensesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LicensesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LicensesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LicensesArgs
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 licensesResource = new Meraki.Organizations.Licenses("licensesResource", new()
{
    LicenseId = "string",
    OrganizationId = "string",
    DeviceSerial = "string",
});
Copy
example, err := organizations.NewLicenses(ctx, "licensesResource", &organizations.LicensesArgs{
	LicenseId:      pulumi.String("string"),
	OrganizationId: pulumi.String("string"),
	DeviceSerial:   pulumi.String("string"),
})
Copy
var licensesResource = new Licenses("licensesResource", LicensesArgs.builder()
    .licenseId("string")
    .organizationId("string")
    .deviceSerial("string")
    .build());
Copy
licenses_resource = meraki.organizations.Licenses("licensesResource",
    license_id="string",
    organization_id="string",
    device_serial="string")
Copy
const licensesResource = new meraki.organizations.Licenses("licensesResource", {
    licenseId: "string",
    organizationId: "string",
    deviceSerial: "string",
});
Copy
type: meraki:organizations:Licenses
properties:
    deviceSerial: string
    licenseId: string
    organizationId: string
Copy

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

LicenseId This property is required. string
licenseId path parameter. License ID
OrganizationId This property is required. string
organizationId path parameter. Organization ID
DeviceSerial string
Serial number of the device the license is assigned to
LicenseId This property is required. string
licenseId path parameter. License ID
OrganizationId This property is required. string
organizationId path parameter. Organization ID
DeviceSerial string
Serial number of the device the license is assigned to
licenseId This property is required. String
licenseId path parameter. License ID
organizationId This property is required. String
organizationId path parameter. Organization ID
deviceSerial String
Serial number of the device the license is assigned to
licenseId This property is required. string
licenseId path parameter. License ID
organizationId This property is required. string
organizationId path parameter. Organization ID
deviceSerial string
Serial number of the device the license is assigned to
license_id This property is required. str
licenseId path parameter. License ID
organization_id This property is required. str
organizationId path parameter. Organization ID
device_serial str
Serial number of the device the license is assigned to
licenseId This property is required. String
licenseId path parameter. License ID
organizationId This property is required. String
organizationId path parameter. Organization ID
deviceSerial String
Serial number of the device the license is assigned to

Outputs

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

ActivationDate string
The date the license started burning
ClaimDate string
The date the license was claimed into the organization
DurationInDays int
The duration of the individual license
ExpirationDate string
The date the license will expire
HeadLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
Id string
The provider-assigned unique ID for this managed resource.
LicenseKey string
License key
LicenseType string
License type
NetworkId string
ID of the network the license is assigned to
OrderNumber string
Order number
PermanentlyQueuedLicenses List<LicensesPermanentlyQueuedLicense>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
SeatCount int
The number of seats of the license. Only applicable to SM licenses.
State string
The state of the license. All queued licenses have a status of recentlyQueued.
TotalDurationInDays int
The duration of the license plus all permanently queued licenses associated with it
ActivationDate string
The date the license started burning
ClaimDate string
The date the license was claimed into the organization
DurationInDays int
The duration of the individual license
ExpirationDate string
The date the license will expire
HeadLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
Id string
The provider-assigned unique ID for this managed resource.
LicenseKey string
License key
LicenseType string
License type
NetworkId string
ID of the network the license is assigned to
OrderNumber string
Order number
PermanentlyQueuedLicenses []LicensesPermanentlyQueuedLicense
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
SeatCount int
The number of seats of the license. Only applicable to SM licenses.
State string
The state of the license. All queued licenses have a status of recentlyQueued.
TotalDurationInDays int
The duration of the license plus all permanently queued licenses associated with it
activationDate String
The date the license started burning
claimDate String
The date the license was claimed into the organization
durationInDays Integer
The duration of the individual license
expirationDate String
The date the license will expire
headLicenseId String
The id of the head license this license is queued behind. If there is no head license, it returns nil.
id String
The provider-assigned unique ID for this managed resource.
licenseKey String
License key
licenseType String
License type
networkId String
ID of the network the license is assigned to
orderNumber String
Order number
permanentlyQueuedLicenses List<LicensesPermanentlyQueuedLicense>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount Integer
The number of seats of the license. Only applicable to SM licenses.
state String
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays Integer
The duration of the license plus all permanently queued licenses associated with it
activationDate string
The date the license started burning
claimDate string
The date the license was claimed into the organization
durationInDays number
The duration of the individual license
expirationDate string
The date the license will expire
headLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
id string
The provider-assigned unique ID for this managed resource.
licenseKey string
License key
licenseType string
License type
networkId string
ID of the network the license is assigned to
orderNumber string
Order number
permanentlyQueuedLicenses LicensesPermanentlyQueuedLicense[]
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount number
The number of seats of the license. Only applicable to SM licenses.
state string
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays number
The duration of the license plus all permanently queued licenses associated with it
activation_date str
The date the license started burning
claim_date str
The date the license was claimed into the organization
duration_in_days int
The duration of the individual license
expiration_date str
The date the license will expire
head_license_id str
The id of the head license this license is queued behind. If there is no head license, it returns nil.
id str
The provider-assigned unique ID for this managed resource.
license_key str
License key
license_type str
License type
network_id str
ID of the network the license is assigned to
order_number str
Order number
permanently_queued_licenses Sequence[LicensesPermanentlyQueuedLicense]
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seat_count int
The number of seats of the license. Only applicable to SM licenses.
state str
The state of the license. All queued licenses have a status of recentlyQueued.
total_duration_in_days int
The duration of the license plus all permanently queued licenses associated with it
activationDate String
The date the license started burning
claimDate String
The date the license was claimed into the organization
durationInDays Number
The duration of the individual license
expirationDate String
The date the license will expire
headLicenseId String
The id of the head license this license is queued behind. If there is no head license, it returns nil.
id String
The provider-assigned unique ID for this managed resource.
licenseKey String
License key
licenseType String
License type
networkId String
ID of the network the license is assigned to
orderNumber String
Order number
permanentlyQueuedLicenses List<Property Map>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount Number
The number of seats of the license. Only applicable to SM licenses.
state String
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays Number
The duration of the license plus all permanently queued licenses associated with it

Look up Existing Licenses Resource

Get an existing Licenses 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?: LicensesState, opts?: CustomResourceOptions): Licenses
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_date: Optional[str] = None,
        claim_date: Optional[str] = None,
        device_serial: Optional[str] = None,
        duration_in_days: Optional[int] = None,
        expiration_date: Optional[str] = None,
        head_license_id: Optional[str] = None,
        license_id: Optional[str] = None,
        license_key: Optional[str] = None,
        license_type: Optional[str] = None,
        network_id: Optional[str] = None,
        order_number: Optional[str] = None,
        organization_id: Optional[str] = None,
        permanently_queued_licenses: Optional[Sequence[LicensesPermanentlyQueuedLicenseArgs]] = None,
        seat_count: Optional[int] = None,
        state: Optional[str] = None,
        total_duration_in_days: Optional[int] = None) -> Licenses
func GetLicenses(ctx *Context, name string, id IDInput, state *LicensesState, opts ...ResourceOption) (*Licenses, error)
public static Licenses Get(string name, Input<string> id, LicensesState? state, CustomResourceOptions? opts = null)
public static Licenses get(String name, Output<String> id, LicensesState state, CustomResourceOptions options)
resources:  _:    type: meraki:organizations:Licenses    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActivationDate string
The date the license started burning
ClaimDate string
The date the license was claimed into the organization
DeviceSerial string
Serial number of the device the license is assigned to
DurationInDays int
The duration of the individual license
ExpirationDate string
The date the license will expire
HeadLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
LicenseId string
licenseId path parameter. License ID
LicenseKey string
License key
LicenseType string
License type
NetworkId string
ID of the network the license is assigned to
OrderNumber string
Order number
OrganizationId string
organizationId path parameter. Organization ID
PermanentlyQueuedLicenses List<LicensesPermanentlyQueuedLicense>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
SeatCount int
The number of seats of the license. Only applicable to SM licenses.
State string
The state of the license. All queued licenses have a status of recentlyQueued.
TotalDurationInDays int
The duration of the license plus all permanently queued licenses associated with it
ActivationDate string
The date the license started burning
ClaimDate string
The date the license was claimed into the organization
DeviceSerial string
Serial number of the device the license is assigned to
DurationInDays int
The duration of the individual license
ExpirationDate string
The date the license will expire
HeadLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
LicenseId string
licenseId path parameter. License ID
LicenseKey string
License key
LicenseType string
License type
NetworkId string
ID of the network the license is assigned to
OrderNumber string
Order number
OrganizationId string
organizationId path parameter. Organization ID
PermanentlyQueuedLicenses []LicensesPermanentlyQueuedLicenseArgs
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
SeatCount int
The number of seats of the license. Only applicable to SM licenses.
State string
The state of the license. All queued licenses have a status of recentlyQueued.
TotalDurationInDays int
The duration of the license plus all permanently queued licenses associated with it
activationDate String
The date the license started burning
claimDate String
The date the license was claimed into the organization
deviceSerial String
Serial number of the device the license is assigned to
durationInDays Integer
The duration of the individual license
expirationDate String
The date the license will expire
headLicenseId String
The id of the head license this license is queued behind. If there is no head license, it returns nil.
licenseId String
licenseId path parameter. License ID
licenseKey String
License key
licenseType String
License type
networkId String
ID of the network the license is assigned to
orderNumber String
Order number
organizationId String
organizationId path parameter. Organization ID
permanentlyQueuedLicenses List<LicensesPermanentlyQueuedLicense>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount Integer
The number of seats of the license. Only applicable to SM licenses.
state String
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays Integer
The duration of the license plus all permanently queued licenses associated with it
activationDate string
The date the license started burning
claimDate string
The date the license was claimed into the organization
deviceSerial string
Serial number of the device the license is assigned to
durationInDays number
The duration of the individual license
expirationDate string
The date the license will expire
headLicenseId string
The id of the head license this license is queued behind. If there is no head license, it returns nil.
licenseId string
licenseId path parameter. License ID
licenseKey string
License key
licenseType string
License type
networkId string
ID of the network the license is assigned to
orderNumber string
Order number
organizationId string
organizationId path parameter. Organization ID
permanentlyQueuedLicenses LicensesPermanentlyQueuedLicense[]
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount number
The number of seats of the license. Only applicable to SM licenses.
state string
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays number
The duration of the license plus all permanently queued licenses associated with it
activation_date str
The date the license started burning
claim_date str
The date the license was claimed into the organization
device_serial str
Serial number of the device the license is assigned to
duration_in_days int
The duration of the individual license
expiration_date str
The date the license will expire
head_license_id str
The id of the head license this license is queued behind. If there is no head license, it returns nil.
license_id str
licenseId path parameter. License ID
license_key str
License key
license_type str
License type
network_id str
ID of the network the license is assigned to
order_number str
Order number
organization_id str
organizationId path parameter. Organization ID
permanently_queued_licenses Sequence[LicensesPermanentlyQueuedLicenseArgs]
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seat_count int
The number of seats of the license. Only applicable to SM licenses.
state str
The state of the license. All queued licenses have a status of recentlyQueued.
total_duration_in_days int
The duration of the license plus all permanently queued licenses associated with it
activationDate String
The date the license started burning
claimDate String
The date the license was claimed into the organization
deviceSerial String
Serial number of the device the license is assigned to
durationInDays Number
The duration of the individual license
expirationDate String
The date the license will expire
headLicenseId String
The id of the head license this license is queued behind. If there is no head license, it returns nil.
licenseId String
licenseId path parameter. License ID
licenseKey String
License key
licenseType String
License type
networkId String
ID of the network the license is assigned to
orderNumber String
Order number
organizationId String
organizationId path parameter. Organization ID
permanentlyQueuedLicenses List<Property Map>
DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
seatCount Number
The number of seats of the license. Only applicable to SM licenses.
state String
The state of the license. All queued licenses have a status of recentlyQueued.
totalDurationInDays Number
The duration of the license plus all permanently queued licenses associated with it

Supporting Types

LicensesPermanentlyQueuedLicense
, LicensesPermanentlyQueuedLicenseArgs

DurationInDays int
The duration of the individual license
Id string
Permanently queued license ID
LicenseKey string
License key
LicenseType string
License type
OrderNumber string
Order number
DurationInDays int
The duration of the individual license
Id string
Permanently queued license ID
LicenseKey string
License key
LicenseType string
License type
OrderNumber string
Order number
durationInDays Integer
The duration of the individual license
id String
Permanently queued license ID
licenseKey String
License key
licenseType String
License type
orderNumber String
Order number
durationInDays number
The duration of the individual license
id string
Permanently queued license ID
licenseKey string
License key
licenseType string
License type
orderNumber string
Order number
duration_in_days int
The duration of the individual license
id str
Permanently queued license ID
license_key str
License key
license_type str
License type
order_number str
Order number
durationInDays Number
The duration of the individual license
id String
Permanently queued license ID
licenseKey String
License key
licenseType String
License type
orderNumber String
Order number

Import

$ pulumi import meraki:organizations/licenses:Licenses example "license_id,organization_id"
Copy

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

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.