@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
106 lines (105 loc) • 4.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource manages the NAC Endpoints (User MACs).
*
* NAC Endpoints (User MACs) provide a database of endpoints identified by their MAC addresses. They can be used assign each endpoint with various attributes, such as name, VLAN, role and client label. Once an endpoint is labeled, the label name can be used to create `junipermist.org.Nactag` resource as match criteria.
*
* The `junipermist.org.Nactag` resource can be used to create Tags regrouping one or multiple endpoint MAC Addresses, but the use of the User MACs provides additional features:
* * possibility to assign specific attributes, like a Name, a Radius Group, a VLAN ID, ...
* * possibility to assign one or multiple Tags (Labels) to a User MAC
* * improved management for large list of MAC Addresses
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const endpointOne = new junipermist.org.NacEndpoint("endpoint_one", {
* mac: "921b638445cd",
* labels: [
* "byod",
* "flr1",
* ],
* vlan: "30",
* notes: "mac address refers to Canon printers",
* name: "endpoint_one",
* radiusGroup: "VIP",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `mist_org_nac_endpoint` with:
*
* NAC Endpoint can be imported by specifying the org_id and the nac_endpoint_id
*
* ```sh
* $ pulumi import junipermist:org/nacEndpoint:NacEndpoint endpoint_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class NacEndpoint extends pulumi.CustomResource {
/**
* Get an existing NacEndpoint resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NacEndpointState, opts?: pulumi.CustomResourceOptions): NacEndpoint;
/**
* Returns true if the given object is an instance of NacEndpoint. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NacEndpoint;
readonly labels: pulumi.Output<string[]>;
/**
* Only non-local-admin MAC is accepted
*/
readonly mac: pulumi.Output<string>;
readonly name: pulumi.Output<string>;
readonly notes: pulumi.Output<string>;
readonly orgId: pulumi.Output<string>;
readonly radiusGroup: pulumi.Output<string>;
readonly vlan: pulumi.Output<string>;
/**
* Create a NacEndpoint resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NacEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NacEndpoint resources.
*/
export interface NacEndpointState {
labels?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Only non-local-admin MAC is accepted
*/
mac?: pulumi.Input<string>;
name?: pulumi.Input<string>;
notes?: pulumi.Input<string>;
orgId?: pulumi.Input<string>;
radiusGroup?: pulumi.Input<string>;
vlan?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NacEndpoint resource.
*/
export interface NacEndpointArgs {
labels?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Only non-local-admin MAC is accepted
*/
mac: pulumi.Input<string>;
name?: pulumi.Input<string>;
notes?: pulumi.Input<string>;
orgId: pulumi.Input<string>;
radiusGroup?: pulumi.Input<string>;
vlan?: pulumi.Input<string>;
}