1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Devicecategory
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.user.Devicecategory

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

    Configure device categories. Applies to FortiOS Version <= 6.2.0.

    Create Devicecategory Resource

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

    Constructor syntax

    new Devicecategory(name: string, args?: DevicecategoryArgs, opts?: CustomResourceOptions);
    @overload
    def Devicecategory(resource_name: str,
                       args: Optional[DevicecategoryArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def Devicecategory(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       comment: Optional[str] = None,
                       desc: Optional[str] = None,
                       name: Optional[str] = None,
                       vdomparam: Optional[str] = None)
    func NewDevicecategory(ctx *Context, name string, args *DevicecategoryArgs, opts ...ResourceOption) (*Devicecategory, error)
    public Devicecategory(string name, DevicecategoryArgs? args = null, CustomResourceOptions? opts = null)
    public Devicecategory(String name, DevicecategoryArgs args)
    public Devicecategory(String name, DevicecategoryArgs args, CustomResourceOptions options)
    
    type: fortios:user:Devicecategory
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DevicecategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DevicecategoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DevicecategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DevicecategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DevicecategoryArgs
    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 devicecategoryResource = new Fortios.User.Devicecategory("devicecategoryResource", new()
    {
        Comment = "string",
        Desc = "string",
        Name = "string",
        Vdomparam = "string",
    });
    
    example, err := user.NewDevicecategory(ctx, "devicecategoryResource", &user.DevicecategoryArgs{
    	Comment:   pulumi.String("string"),
    	Desc:      pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var devicecategoryResource = new Devicecategory("devicecategoryResource", DevicecategoryArgs.builder()
        .comment("string")
        .desc("string")
        .name("string")
        .vdomparam("string")
        .build());
    
    devicecategory_resource = fortios.user.Devicecategory("devicecategoryResource",
        comment="string",
        desc="string",
        name="string",
        vdomparam="string")
    
    const devicecategoryResource = new fortios.user.Devicecategory("devicecategoryResource", {
        comment: "string",
        desc: "string",
        name: "string",
        vdomparam: "string",
    });
    
    type: fortios:user:Devicecategory
    properties:
        comment: string
        desc: string
        name: string
        vdomparam: string
    

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

    Comment string
    Comment.
    Desc string
    Device category description.
    Name string
    Device category name.
    Vdomparam string
    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.
    Comment string
    Comment.
    Desc string
    Device category description.
    Name string
    Device category name.
    Vdomparam string
    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.
    comment String
    Comment.
    desc String
    Device category description.
    name String
    Device category name.
    vdomparam String
    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.
    comment string
    Comment.
    desc string
    Device category description.
    name string
    Device category name.
    vdomparam string
    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.
    comment str
    Comment.
    desc str
    Device category description.
    name str
    Device category name.
    vdomparam str
    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.
    comment String
    Comment.
    desc String
    Device category description.
    name String
    Device category name.
    vdomparam String
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Devicecategory Resource

    Get an existing Devicecategory 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?: DevicecategoryState, opts?: CustomResourceOptions): Devicecategory
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            desc: Optional[str] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Devicecategory
    func GetDevicecategory(ctx *Context, name string, id IDInput, state *DevicecategoryState, opts ...ResourceOption) (*Devicecategory, error)
    public static Devicecategory Get(string name, Input<string> id, DevicecategoryState? state, CustomResourceOptions? opts = null)
    public static Devicecategory get(String name, Output<String> id, DevicecategoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Comment string
    Comment.
    Desc string
    Device category description.
    Name string
    Device category name.
    Vdomparam string
    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.
    Comment string
    Comment.
    Desc string
    Device category description.
    Name string
    Device category name.
    Vdomparam string
    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.
    comment String
    Comment.
    desc String
    Device category description.
    name String
    Device category name.
    vdomparam String
    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.
    comment string
    Comment.
    desc string
    Device category description.
    name string
    Device category name.
    vdomparam string
    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.
    comment str
    Comment.
    desc str
    Device category description.
    name str
    Device category name.
    vdomparam str
    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.
    comment String
    Comment.
    desc String
    Device category description.
    name String
    Device category name.
    vdomparam String
    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.

    Import

    User DeviceCategory can be imported using any of these accepted formats:

    $ pulumi import fortios:user/devicecategory:Devicecategory labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/devicecategory:Devicecategory labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse