1. Packages
  2. Juniper Mist
  3. API Docs
  4. org
  5. getInventory
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

junipermist.org.getInventory

Explore with Pulumi AI

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

    This data source provides the list of Devices in the Org inventory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as junipermist from "@pulumi/junipermist";
    
    const inventory = junipermist.org.getInventory({
        orgId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
    });
    
    import pulumi
    import pulumi_junipermist as junipermist
    
    inventory = junipermist.org.get_inventory(org_id="15fca2ac-b1a6-47cc-9953-cc6906281550")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-junipermist/sdk/go/junipermist/org"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := org.LookupInventory(ctx, &org.LookupInventoryArgs{
    			OrgId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
    		}, 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 inventory = JuniperMist.Org.GetInventory.Invoke(new()
        {
            OrgId = "15fca2ac-b1a6-47cc-9953-cc6906281550",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.org.OrgFunctions;
    import com.pulumi.junipermist.org.inputs.GetInventoryArgs;
    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 inventory = OrgFunctions.getInventory(GetInventoryArgs.builder()
                .orgId("15fca2ac-b1a6-47cc-9953-cc6906281550")
                .build());
    
        }
    }
    
    variables:
      inventory:
        fn::invoke:
          Function: junipermist:org:getInventory
          Arguments:
            orgId: 15fca2ac-b1a6-47cc-9953-cc6906281550
    

    Using getInventory

    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 getInventory(args: GetInventoryArgs, opts?: InvokeOptions): Promise<GetInventoryResult>
    function getInventoryOutput(args: GetInventoryOutputArgs, opts?: InvokeOptions): Output<GetInventoryResult>
    def get_inventory(mac: Optional[str] = None,
                      model: Optional[str] = None,
                      org_id: Optional[str] = None,
                      serial: Optional[str] = None,
                      site_id: Optional[str] = None,
                      unassigned: Optional[bool] = None,
                      vc: Optional[bool] = None,
                      vc_mac: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInventoryResult
    def get_inventory_output(mac: Optional[pulumi.Input[str]] = None,
                      model: Optional[pulumi.Input[str]] = None,
                      org_id: Optional[pulumi.Input[str]] = None,
                      serial: Optional[pulumi.Input[str]] = None,
                      site_id: Optional[pulumi.Input[str]] = None,
                      unassigned: Optional[pulumi.Input[bool]] = None,
                      vc: Optional[pulumi.Input[bool]] = None,
                      vc_mac: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInventoryResult]
    func LookupInventory(ctx *Context, args *LookupInventoryArgs, opts ...InvokeOption) (*LookupInventoryResult, error)
    func LookupInventoryOutput(ctx *Context, args *LookupInventoryOutputArgs, opts ...InvokeOption) LookupInventoryResultOutput

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

    public static class GetInventory 
    {
        public static Task<GetInventoryResult> InvokeAsync(GetInventoryArgs args, InvokeOptions? opts = null)
        public static Output<GetInventoryResult> Invoke(GetInventoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInventoryResult> getInventory(GetInventoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: junipermist:org/getInventory:getInventory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrgId string
    Mac string
    MAC address
    Model string
    device model
    Serial string
    device serial
    SiteId string
    site id if assigned, null if not assigned
    Unassigned bool
    to display Unassigned devices
    Vc bool
    To display Virtual Chassis members
    VcMac string
    Virtual Chassis MAC Address
    OrgId string
    Mac string
    MAC address
    Model string
    device model
    Serial string
    device serial
    SiteId string
    site id if assigned, null if not assigned
    Unassigned bool
    to display Unassigned devices
    Vc bool
    To display Virtual Chassis members
    VcMac string
    Virtual Chassis MAC Address
    orgId String
    mac String
    MAC address
    model String
    device model
    serial String
    device serial
    siteId String
    site id if assigned, null if not assigned
    unassigned Boolean
    to display Unassigned devices
    vc Boolean
    To display Virtual Chassis members
    vcMac String
    Virtual Chassis MAC Address
    orgId string
    mac string
    MAC address
    model string
    device model
    serial string
    device serial
    siteId string
    site id if assigned, null if not assigned
    unassigned boolean
    to display Unassigned devices
    vc boolean
    To display Virtual Chassis members
    vcMac string
    Virtual Chassis MAC Address
    org_id str
    mac str
    MAC address
    model str
    device model
    serial str
    device serial
    site_id str
    site id if assigned, null if not assigned
    unassigned bool
    to display Unassigned devices
    vc bool
    To display Virtual Chassis members
    vc_mac str
    Virtual Chassis MAC Address
    orgId String
    mac String
    MAC address
    model String
    device model
    serial String
    device serial
    siteId String
    site id if assigned, null if not assigned
    unassigned Boolean
    to display Unassigned devices
    vc Boolean
    To display Virtual Chassis members
    vcMac String
    Virtual Chassis MAC Address

    getInventory Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    OrgInventories List<Pulumi.JuniperMist.Org.Outputs.GetInventoryOrgInventory>
    List of devices
    Mac string
    MAC address
    Model string
    device model
    Serial string
    device serial
    SiteId string
    site id if assigned, null if not assigned
    Unassigned bool
    to display Unassigned devices
    Vc bool
    To display Virtual Chassis members
    VcMac string
    Virtual Chassis MAC Address
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    OrgInventories []GetInventoryOrgInventory
    List of devices
    Mac string
    MAC address
    Model string
    device model
    Serial string
    device serial
    SiteId string
    site id if assigned, null if not assigned
    Unassigned bool
    to display Unassigned devices
    Vc bool
    To display Virtual Chassis members
    VcMac string
    Virtual Chassis MAC Address
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    orgInventories List<GetInventoryOrgInventory>
    List of devices
    mac String
    MAC address
    model String
    device model
    serial String
    device serial
    siteId String
    site id if assigned, null if not assigned
    unassigned Boolean
    to display Unassigned devices
    vc Boolean
    To display Virtual Chassis members
    vcMac String
    Virtual Chassis MAC Address
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    orgInventories GetInventoryOrgInventory[]
    List of devices
    mac string
    MAC address
    model string
    device model
    serial string
    device serial
    siteId string
    site id if assigned, null if not assigned
    unassigned boolean
    to display Unassigned devices
    vc boolean
    To display Virtual Chassis members
    vcMac string
    Virtual Chassis MAC Address
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    org_inventories Sequence[GetInventoryOrgInventory]
    List of devices
    mac str
    MAC address
    model str
    device model
    serial str
    device serial
    site_id str
    site id if assigned, null if not assigned
    unassigned bool
    to display Unassigned devices
    vc bool
    To display Virtual Chassis members
    vc_mac str
    Virtual Chassis MAC Address
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    orgInventories List<Property Map>
    List of devices
    mac String
    MAC address
    model String
    device model
    serial String
    device serial
    siteId String
    site id if assigned, null if not assigned
    unassigned Boolean
    to display Unassigned devices
    vc Boolean
    To display Virtual Chassis members
    vcMac String
    Virtual Chassis MAC Address

    Supporting Types

    GetInventoryOrgInventory

    Adopted bool
    only if type==switch or type==gateway whether the switch/gateway is adopted
    ClaimCode string
    device claim code
    Connected bool
    whether the device is connected
    DeviceprofileId string
    deviceprofile id if assigned, null if not assigned
    Hostname string
    hostname reported by the device
    HwRev string
    device hardware revision number
    Id string
    device id
    Jsi bool
    Mac string
    device MAC address
    Model string
    device model
    Name string
    device name if configured
    OrgId string
    Serial string
    device serial
    SiteId string
    Site ID where the device is assigned to
    Sku string
    device stock keeping unit
    Type string
    enum: ap, gateway, switch
    VcMac string
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster
    Adopted bool
    only if type==switch or type==gateway whether the switch/gateway is adopted
    ClaimCode string
    device claim code
    Connected bool
    whether the device is connected
    DeviceprofileId string
    deviceprofile id if assigned, null if not assigned
    Hostname string
    hostname reported by the device
    HwRev string
    device hardware revision number
    Id string
    device id
    Jsi bool
    Mac string
    device MAC address
    Model string
    device model
    Name string
    device name if configured
    OrgId string
    Serial string
    device serial
    SiteId string
    Site ID where the device is assigned to
    Sku string
    device stock keeping unit
    Type string
    enum: ap, gateway, switch
    VcMac string
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster
    adopted Boolean
    only if type==switch or type==gateway whether the switch/gateway is adopted
    claimCode String
    device claim code
    connected Boolean
    whether the device is connected
    deviceprofileId String
    deviceprofile id if assigned, null if not assigned
    hostname String
    hostname reported by the device
    hwRev String
    device hardware revision number
    id String
    device id
    jsi Boolean
    mac String
    device MAC address
    model String
    device model
    name String
    device name if configured
    orgId String
    serial String
    device serial
    siteId String
    Site ID where the device is assigned to
    sku String
    device stock keeping unit
    type String
    enum: ap, gateway, switch
    vcMac String
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster
    adopted boolean
    only if type==switch or type==gateway whether the switch/gateway is adopted
    claimCode string
    device claim code
    connected boolean
    whether the device is connected
    deviceprofileId string
    deviceprofile id if assigned, null if not assigned
    hostname string
    hostname reported by the device
    hwRev string
    device hardware revision number
    id string
    device id
    jsi boolean
    mac string
    device MAC address
    model string
    device model
    name string
    device name if configured
    orgId string
    serial string
    device serial
    siteId string
    Site ID where the device is assigned to
    sku string
    device stock keeping unit
    type string
    enum: ap, gateway, switch
    vcMac string
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster
    adopted bool
    only if type==switch or type==gateway whether the switch/gateway is adopted
    claim_code str
    device claim code
    connected bool
    whether the device is connected
    deviceprofile_id str
    deviceprofile id if assigned, null if not assigned
    hostname str
    hostname reported by the device
    hw_rev str
    device hardware revision number
    id str
    device id
    jsi bool
    mac str
    device MAC address
    model str
    device model
    name str
    device name if configured
    org_id str
    serial str
    device serial
    site_id str
    Site ID where the device is assigned to
    sku str
    device stock keeping unit
    type str
    enum: ap, gateway, switch
    vc_mac str
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster
    adopted Boolean
    only if type==switch or type==gateway whether the switch/gateway is adopted
    claimCode String
    device claim code
    connected Boolean
    whether the device is connected
    deviceprofileId String
    deviceprofile id if assigned, null if not assigned
    hostname String
    hostname reported by the device
    hwRev String
    device hardware revision number
    id String
    device id
    jsi Boolean
    mac String
    device MAC address
    model String
    device model
    name String
    device name if configured
    orgId String
    serial String
    device serial
    siteId String
    Site ID where the device is assigned to
    sku String
    device stock keeping unit
    type String
    enum: ap, gateway, switch
    vcMac String
    if type==switch and device part of a Virtual Chassis, MAC Address of the Virtual Chassis. if type==gateway and device part of a Clust, MAC Address of the Cluster

    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