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

meraki.organizations.InventoryClaim

Explore with Pulumi AI

~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

Example Usage

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

const example = new meraki.organizations.InventoryClaim("example", {
    organizationId: "string",
    parameters: {
        licenses: [{
            key: "Z2XXXXXXXXXX",
            mode: "addDevices",
        }],
        orders: ["4CXXXXXXX"],
        serials: ["Q234-ABCD-5678"],
    },
});
export const merakiOrganizationsInventoryClaimExample = example;
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.InventoryClaim("example",
    organization_id="string",
    parameters={
        "licenses": [{
            "key": "Z2XXXXXXXXXX",
            "mode": "addDevices",
        }],
        "orders": ["4CXXXXXXX"],
        "serials": ["Q234-ABCD-5678"],
    })
pulumi.export("merakiOrganizationsInventoryClaimExample", 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.NewInventoryClaim(ctx, "example", &organizations.InventoryClaimArgs{
			OrganizationId: pulumi.String("string"),
			Parameters: &organizations.InventoryClaimParametersArgs{
				Licenses: organizations.InventoryClaimParametersLicenseArray{
					&organizations.InventoryClaimParametersLicenseArgs{
						Key:  pulumi.String("Z2XXXXXXXXXX"),
						Mode: pulumi.String("addDevices"),
					},
				},
				Orders: pulumi.StringArray{
					pulumi.String("4CXXXXXXX"),
				},
				Serials: pulumi.StringArray{
					pulumi.String("Q234-ABCD-5678"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsInventoryClaimExample", 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.InventoryClaim("example", new()
    {
        OrganizationId = "string",
        Parameters = new Meraki.Organizations.Inputs.InventoryClaimParametersArgs
        {
            Licenses = new[]
            {
                new Meraki.Organizations.Inputs.InventoryClaimParametersLicenseArgs
                {
                    Key = "Z2XXXXXXXXXX",
                    Mode = "addDevices",
                },
            },
            Orders = new[]
            {
                "4CXXXXXXX",
            },
            Serials = new[]
            {
                "Q234-ABCD-5678",
            },
        },
    });

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

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.InventoryClaim;
import com.pulumi.meraki.organizations.InventoryClaimArgs;
import com.pulumi.meraki.organizations.inputs.InventoryClaimParametersArgs;
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 InventoryClaim("example", InventoryClaimArgs.builder()
            .organizationId("string")
            .parameters(InventoryClaimParametersArgs.builder()
                .licenses(InventoryClaimParametersLicenseArgs.builder()
                    .key("Z2XXXXXXXXXX")
                    .mode("addDevices")
                    .build())
                .orders("4CXXXXXXX")
                .serials("Q234-ABCD-5678")
                .build())
            .build());

        ctx.export("merakiOrganizationsInventoryClaimExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:organizations:InventoryClaim
    properties:
      organizationId: string
      parameters:
        licenses:
          - key: Z2XXXXXXXXXX
            mode: addDevices
        orders:
          - 4CXXXXXXX
        serials:
          - Q234-ABCD-5678
outputs:
  merakiOrganizationsInventoryClaimExample: ${example}
Copy

Create InventoryClaim Resource

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

Constructor syntax

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

@overload
def InventoryClaim(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   organization_id: Optional[str] = None,
                   parameters: Optional[InventoryClaimParametersArgs] = None)
func NewInventoryClaim(ctx *Context, name string, args InventoryClaimArgs, opts ...ResourceOption) (*InventoryClaim, error)
public InventoryClaim(string name, InventoryClaimArgs args, CustomResourceOptions? opts = null)
public InventoryClaim(String name, InventoryClaimArgs args)
public InventoryClaim(String name, InventoryClaimArgs args, CustomResourceOptions options)
type: meraki:organizations:InventoryClaim
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. InventoryClaimArgs
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. InventoryClaimArgs
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. InventoryClaimArgs
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. InventoryClaimArgs
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. InventoryClaimArgs
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 inventoryClaimResource = new Meraki.Organizations.InventoryClaim("inventoryClaimResource", new()
{
    OrganizationId = "string",
    Parameters = new Meraki.Organizations.Inputs.InventoryClaimParametersArgs
    {
        Licenses = new[]
        {
            new Meraki.Organizations.Inputs.InventoryClaimParametersLicenseArgs
            {
                Key = "string",
                Mode = "string",
            },
        },
        Orders = new[]
        {
            "string",
        },
        Serials = new[]
        {
            "string",
        },
    },
});
Copy
example, err := organizations.NewInventoryClaim(ctx, "inventoryClaimResource", &organizations.InventoryClaimArgs{
	OrganizationId: pulumi.String("string"),
	Parameters: &organizations.InventoryClaimParametersArgs{
		Licenses: organizations.InventoryClaimParametersLicenseArray{
			&organizations.InventoryClaimParametersLicenseArgs{
				Key:  pulumi.String("string"),
				Mode: pulumi.String("string"),
			},
		},
		Orders: pulumi.StringArray{
			pulumi.String("string"),
		},
		Serials: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})
Copy
var inventoryClaimResource = new InventoryClaim("inventoryClaimResource", InventoryClaimArgs.builder()
    .organizationId("string")
    .parameters(InventoryClaimParametersArgs.builder()
        .licenses(InventoryClaimParametersLicenseArgs.builder()
            .key("string")
            .mode("string")
            .build())
        .orders("string")
        .serials("string")
        .build())
    .build());
Copy
inventory_claim_resource = meraki.organizations.InventoryClaim("inventoryClaimResource",
    organization_id="string",
    parameters={
        "licenses": [{
            "key": "string",
            "mode": "string",
        }],
        "orders": ["string"],
        "serials": ["string"],
    })
Copy
const inventoryClaimResource = new meraki.organizations.InventoryClaim("inventoryClaimResource", {
    organizationId: "string",
    parameters: {
        licenses: [{
            key: "string",
            mode: "string",
        }],
        orders: ["string"],
        serials: ["string"],
    },
});
Copy
type: meraki:organizations:InventoryClaim
properties:
    organizationId: string
    parameters:
        licenses:
            - key: string
              mode: string
        orders:
            - string
        serials:
            - string
Copy

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

OrganizationId This property is required. string
organizationId path parameter. Organization ID
Parameters This property is required. InventoryClaimParameters
OrganizationId This property is required. string
organizationId path parameter. Organization ID
Parameters This property is required. InventoryClaimParametersArgs
organizationId This property is required. String
organizationId path parameter. Organization ID
parameters This property is required. InventoryClaimParameters
organizationId This property is required. string
organizationId path parameter. Organization ID
parameters This property is required. InventoryClaimParameters
organization_id This property is required. str
organizationId path parameter. Organization ID
parameters This property is required. InventoryClaimParametersArgs
organizationId This property is required. String
organizationId path parameter. Organization ID
parameters This property is required. Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Item InventoryClaimItem
Id string
The provider-assigned unique ID for this managed resource.
Item InventoryClaimItem
id String
The provider-assigned unique ID for this managed resource.
item InventoryClaimItem
id string
The provider-assigned unique ID for this managed resource.
item InventoryClaimItem
id str
The provider-assigned unique ID for this managed resource.
item InventoryClaimItem
id String
The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing InventoryClaim Resource

Get an existing InventoryClaim 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?: InventoryClaimState, opts?: CustomResourceOptions): InventoryClaim
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[InventoryClaimItemArgs] = None,
        organization_id: Optional[str] = None,
        parameters: Optional[InventoryClaimParametersArgs] = None) -> InventoryClaim
func GetInventoryClaim(ctx *Context, name string, id IDInput, state *InventoryClaimState, opts ...ResourceOption) (*InventoryClaim, error)
public static InventoryClaim Get(string name, Input<string> id, InventoryClaimState? state, CustomResourceOptions? opts = null)
public static InventoryClaim get(String name, Output<String> id, InventoryClaimState state, CustomResourceOptions options)
resources:  _:    type: meraki:organizations:InventoryClaim    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:
Item InventoryClaimItem
OrganizationId string
organizationId path parameter. Organization ID
Parameters InventoryClaimParameters
Item InventoryClaimItemArgs
OrganizationId string
organizationId path parameter. Organization ID
Parameters InventoryClaimParametersArgs
item InventoryClaimItem
organizationId String
organizationId path parameter. Organization ID
parameters InventoryClaimParameters
item InventoryClaimItem
organizationId string
organizationId path parameter. Organization ID
parameters InventoryClaimParameters
item Property Map
organizationId String
organizationId path parameter. Organization ID
parameters Property Map

Supporting Types

InventoryClaimItem
, InventoryClaimItemArgs

Licenses List<InventoryClaimItemLicense>
The licenses claimed
Orders List<string>
The numbers of the orders claimed
Serials List<string>
The serials of the devices claimed
Licenses []InventoryClaimItemLicense
The licenses claimed
Orders []string
The numbers of the orders claimed
Serials []string
The serials of the devices claimed
licenses List<InventoryClaimItemLicense>
The licenses claimed
orders List<String>
The numbers of the orders claimed
serials List<String>
The serials of the devices claimed
licenses InventoryClaimItemLicense[]
The licenses claimed
orders string[]
The numbers of the orders claimed
serials string[]
The serials of the devices claimed
licenses Sequence[InventoryClaimItemLicense]
The licenses claimed
orders Sequence[str]
The numbers of the orders claimed
serials Sequence[str]
The serials of the devices claimed
licenses List<Property Map>
The licenses claimed
orders List<String>
The numbers of the orders claimed
serials List<String>
The serials of the devices claimed

InventoryClaimItemLicense
, InventoryClaimItemLicenseArgs

Key string
The key of the license
Mode string
The mode of the license
Key string
The key of the license
Mode string
The mode of the license
key String
The key of the license
mode String
The mode of the license
key string
The key of the license
mode string
The mode of the license
key str
The key of the license
mode str
The mode of the license
key String
The key of the license
mode String
The mode of the license

InventoryClaimParameters
, InventoryClaimParametersArgs

Licenses List<InventoryClaimParametersLicense>
The licenses that should be claimed
Orders List<string>
The numbers of the orders that should be claimed
Serials List<string>
The serials of the devices that should be claimed
Licenses []InventoryClaimParametersLicense
The licenses that should be claimed
Orders []string
The numbers of the orders that should be claimed
Serials []string
The serials of the devices that should be claimed
licenses List<InventoryClaimParametersLicense>
The licenses that should be claimed
orders List<String>
The numbers of the orders that should be claimed
serials List<String>
The serials of the devices that should be claimed
licenses InventoryClaimParametersLicense[]
The licenses that should be claimed
orders string[]
The numbers of the orders that should be claimed
serials string[]
The serials of the devices that should be claimed
licenses Sequence[InventoryClaimParametersLicense]
The licenses that should be claimed
orders Sequence[str]
The numbers of the orders that should be claimed
serials Sequence[str]
The serials of the devices that should be claimed
licenses List<Property Map>
The licenses that should be claimed
orders List<String>
The numbers of the orders that should be claimed
serials List<String>
The serials of the devices that should be claimed

InventoryClaimParametersLicense
, InventoryClaimParametersLicenseArgs

Key string
The key of the license
Mode string
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.
Key string
The key of the license
Mode string
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.
key String
The key of the license
mode String
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.
key string
The key of the license
mode string
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.
key str
The key of the license
mode str
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.
key String
The key of the license
mode String
Co-term licensing only: either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. Does not apply to organizations using per-device licensing model.

Package Details

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