@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
161 lines (160 loc) • 7.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure device groups. Applies to FortiOS Version `<= 6.2.0`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trnames12 = new fortios.user.Device("trnames12", {
* alias: "user_devices2",
* category: "amazon-device",
* mac: "08:00:20:0a:1c:1d",
* type: "unknown",
* });
* const trname = new fortios.user.Devicegroup("trname", {members: [{
* name: trnames12.alias,
* }]});
* ```
*
* ## Import
*
* User DeviceGroup can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:user/devicegroup:Devicegroup labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:user/devicegroup:Devicegroup labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Devicegroup extends pulumi.CustomResource {
/**
* Get an existing Devicegroup 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?: DevicegroupState, opts?: pulumi.CustomResourceOptions): Devicegroup;
/**
* Returns true if the given object is an instance of Devicegroup. 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 Devicegroup;
/**
* Comment.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Device group member. The structure of `member` block is documented below.
*/
readonly members: pulumi.Output<outputs.user.DevicegroupMember[] | undefined>;
/**
* Device group name.
*/
readonly name: pulumi.Output<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
readonly taggings: pulumi.Output<outputs.user.DevicegroupTagging[] | undefined>;
/**
* Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Create a Devicegroup 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?: DevicegroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Devicegroup resources.
*/
export interface DevicegroupState {
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Device group member. The structure of `member` block is documented below.
*/
members?: pulumi.Input<pulumi.Input<inputs.user.DevicegroupMember>[]>;
/**
* Device group name.
*/
name?: pulumi.Input<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.user.DevicegroupTagging>[]>;
/**
* Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
*/
vdomparam?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Devicegroup resource.
*/
export interface DevicegroupArgs {
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Device group member. The structure of `member` block is documented below.
*/
members?: pulumi.Input<pulumi.Input<inputs.user.DevicegroupMember>[]>;
/**
* Device group name.
*/
name?: pulumi.Input<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.user.DevicegroupTagging>[]>;
/**
* Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
*/
vdomparam?: pulumi.Input<string>;
}