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

fortios.user.Device

Explore with Pulumi AI

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

    Configure devices. Applies to FortiOS Version <= 6.2.0.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.user.Device("trname", {
        alias: "1",
        category: "amazon-device",
        mac: "08:00:20:0a:8c:6d",
        type: "unknown",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.user.Device("trname",
        alias="1",
        category="amazon-device",
        mac="08:00:20:0a:8c:6d",
        type="unknown")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/user"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := user.NewDevice(ctx, "trname", &user.DeviceArgs{
    			Alias:    pulumi.String("1"),
    			Category: pulumi.String("amazon-device"),
    			Mac:      pulumi.String("08:00:20:0a:8c:6d"),
    			Type:     pulumi.String("unknown"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.User.Device("trname", new()
        {
            Alias = "1",
            Category = "amazon-device",
            Mac = "08:00:20:0a:8c:6d",
            Type = "unknown",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.user.Device;
    import com.pulumi.fortios.user.DeviceArgs;
    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 trname = new Device("trname", DeviceArgs.builder()
                .alias("1")
                .category("amazon-device")
                .mac("08:00:20:0a:8c:6d")
                .type("unknown")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:user:Device
        properties:
          alias: '1'
          category: amazon-device
          mac: 08:00:20:0a:8c:6d
          type: unknown
    

    Create Device Resource

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

    Constructor syntax

    new Device(name: string, args?: DeviceArgs, opts?: CustomResourceOptions);
    @overload
    def Device(resource_name: str,
               args: Optional[DeviceArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Device(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alias: Optional[str] = None,
               avatar: Optional[str] = None,
               category: Optional[str] = None,
               comment: Optional[str] = None,
               dynamic_sort_subtable: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               mac: Optional[str] = None,
               master_device: Optional[str] = None,
               taggings: Optional[Sequence[DeviceTaggingArgs]] = None,
               type: Optional[str] = None,
               user: Optional[str] = None,
               vdomparam: Optional[str] = None)
    func NewDevice(ctx *Context, name string, args *DeviceArgs, opts ...ResourceOption) (*Device, error)
    public Device(string name, DeviceArgs? args = null, CustomResourceOptions? opts = null)
    public Device(String name, DeviceArgs args)
    public Device(String name, DeviceArgs args, CustomResourceOptions options)
    
    type: fortios:user:Device
    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 DeviceArgs
    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 DeviceArgs
    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 DeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceArgs
    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 deviceResource = new Fortios.User.Device("deviceResource", new()
    {
        Alias = "string",
        Avatar = "string",
        Category = "string",
        Comment = "string",
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        Mac = "string",
        MasterDevice = "string",
        Taggings = new[]
        {
            new Fortios.User.Inputs.DeviceTaggingArgs
            {
                Category = "string",
                Name = "string",
                Tags = new[]
                {
                    new Fortios.User.Inputs.DeviceTaggingTagArgs
                    {
                        Name = "string",
                    },
                },
            },
        },
        Type = "string",
        User = "string",
        Vdomparam = "string",
    });
    
    example, err := user.NewDevice(ctx, "deviceResource", &user.DeviceArgs{
    	Alias:               pulumi.String("string"),
    	Avatar:              pulumi.String("string"),
    	Category:            pulumi.String("string"),
    	Comment:             pulumi.String("string"),
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	Mac:                 pulumi.String("string"),
    	MasterDevice:        pulumi.String("string"),
    	Taggings: user.DeviceTaggingArray{
    		&user.DeviceTaggingArgs{
    			Category: pulumi.String("string"),
    			Name:     pulumi.String("string"),
    			Tags: user.DeviceTaggingTagArray{
    				&user.DeviceTaggingTagArgs{
    					Name: pulumi.String("string"),
    				},
    			},
    		},
    	},
    	Type:      pulumi.String("string"),
    	User:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var deviceResource = new Device("deviceResource", DeviceArgs.builder()
        .alias("string")
        .avatar("string")
        .category("string")
        .comment("string")
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .mac("string")
        .masterDevice("string")
        .taggings(DeviceTaggingArgs.builder()
            .category("string")
            .name("string")
            .tags(DeviceTaggingTagArgs.builder()
                .name("string")
                .build())
            .build())
        .type("string")
        .user("string")
        .vdomparam("string")
        .build());
    
    device_resource = fortios.user.Device("deviceResource",
        alias="string",
        avatar="string",
        category="string",
        comment="string",
        dynamic_sort_subtable="string",
        get_all_tables="string",
        mac="string",
        master_device="string",
        taggings=[{
            "category": "string",
            "name": "string",
            "tags": [{
                "name": "string",
            }],
        }],
        type="string",
        user="string",
        vdomparam="string")
    
    const deviceResource = new fortios.user.Device("deviceResource", {
        alias: "string",
        avatar: "string",
        category: "string",
        comment: "string",
        dynamicSortSubtable: "string",
        getAllTables: "string",
        mac: "string",
        masterDevice: "string",
        taggings: [{
            category: "string",
            name: "string",
            tags: [{
                name: "string",
            }],
        }],
        type: "string",
        user: "string",
        vdomparam: "string",
    });
    
    type: fortios:user:Device
    properties:
        alias: string
        avatar: string
        category: string
        comment: string
        dynamicSortSubtable: string
        getAllTables: string
        mac: string
        masterDevice: string
        taggings:
            - category: string
              name: string
              tags:
                - name: string
        type: string
        user: string
        vdomparam: string
    

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

    Alias string
    Device alias.
    Avatar string
    Image file for avatar (maximum 4K base64 encoded).
    Category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    Comment string
    Comment.
    DynamicSortSubtable 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 ].
    GetAllTables 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.
    Mac string
    Device MAC address.
    MasterDevice string
    Master device (optional).
    Taggings List<Pulumiverse.Fortios.User.Inputs.DeviceTagging>
    Config object tagging. The structure of tagging block is documented below.
    Type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    User string
    User 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.
    Alias string
    Device alias.
    Avatar string
    Image file for avatar (maximum 4K base64 encoded).
    Category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    Comment string
    Comment.
    DynamicSortSubtable 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 ].
    GetAllTables 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.
    Mac string
    Device MAC address.
    MasterDevice string
    Master device (optional).
    Taggings []DeviceTaggingArgs
    Config object tagging. The structure of tagging block is documented below.
    Type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    User string
    User 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.
    alias String
    Device alias.
    avatar String
    Image file for avatar (maximum 4K base64 encoded).
    category String
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment String
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac String
    Device MAC address.
    masterDevice String
    Master device (optional).
    taggings List<DeviceTagging>
    Config object tagging. The structure of tagging block is documented below.
    type String
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user String
    User 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.
    alias string
    Device alias.
    avatar string
    Image file for avatar (maximum 4K base64 encoded).
    category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment string
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac string
    Device MAC address.
    masterDevice string
    Master device (optional).
    taggings DeviceTagging[]
    Config object tagging. The structure of tagging block is documented below.
    type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user string
    User 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.
    alias str
    Device alias.
    avatar str
    Image file for avatar (maximum 4K base64 encoded).
    category str
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment str
    Comment.
    dynamic_sort_subtable str
    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 ].
    get_all_tables str
    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.
    mac str
    Device MAC address.
    master_device str
    Master device (optional).
    taggings Sequence[DeviceTaggingArgs]
    Config object tagging. The structure of tagging block is documented below.
    type str
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user str
    User 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.
    alias String
    Device alias.
    avatar String
    Image file for avatar (maximum 4K base64 encoded).
    category String
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment String
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac String
    Device MAC address.
    masterDevice String
    Master device (optional).
    taggings List<Property Map>
    Config object tagging. The structure of tagging block is documented below.
    type String
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user String
    User 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 Device 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 Device Resource

    Get an existing Device 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?: DeviceState, opts?: CustomResourceOptions): Device
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alias: Optional[str] = None,
            avatar: Optional[str] = None,
            category: Optional[str] = None,
            comment: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            mac: Optional[str] = None,
            master_device: Optional[str] = None,
            taggings: Optional[Sequence[DeviceTaggingArgs]] = None,
            type: Optional[str] = None,
            user: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Device
    func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
    public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
    public static Device get(String name, Output<String> id, DeviceState 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:
    Alias string
    Device alias.
    Avatar string
    Image file for avatar (maximum 4K base64 encoded).
    Category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    Comment string
    Comment.
    DynamicSortSubtable 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 ].
    GetAllTables 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.
    Mac string
    Device MAC address.
    MasterDevice string
    Master device (optional).
    Taggings List<Pulumiverse.Fortios.User.Inputs.DeviceTagging>
    Config object tagging. The structure of tagging block is documented below.
    Type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    User string
    User 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.
    Alias string
    Device alias.
    Avatar string
    Image file for avatar (maximum 4K base64 encoded).
    Category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    Comment string
    Comment.
    DynamicSortSubtable 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 ].
    GetAllTables 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.
    Mac string
    Device MAC address.
    MasterDevice string
    Master device (optional).
    Taggings []DeviceTaggingArgs
    Config object tagging. The structure of tagging block is documented below.
    Type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    User string
    User 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.
    alias String
    Device alias.
    avatar String
    Image file for avatar (maximum 4K base64 encoded).
    category String
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment String
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac String
    Device MAC address.
    masterDevice String
    Master device (optional).
    taggings List<DeviceTagging>
    Config object tagging. The structure of tagging block is documented below.
    type String
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user String
    User 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.
    alias string
    Device alias.
    avatar string
    Image file for avatar (maximum 4K base64 encoded).
    category string
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment string
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac string
    Device MAC address.
    masterDevice string
    Master device (optional).
    taggings DeviceTagging[]
    Config object tagging. The structure of tagging block is documented below.
    type string
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user string
    User 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.
    alias str
    Device alias.
    avatar str
    Image file for avatar (maximum 4K base64 encoded).
    category str
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment str
    Comment.
    dynamic_sort_subtable str
    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 ].
    get_all_tables str
    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.
    mac str
    Device MAC address.
    master_device str
    Master device (optional).
    taggings Sequence[DeviceTaggingArgs]
    Config object tagging. The structure of tagging block is documented below.
    type str
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user str
    User 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.
    alias String
    Device alias.
    avatar String
    Image file for avatar (maximum 4K base64 encoded).
    category String
    Device category. Valid values: none, amazon-device, android-device, blackberry-device, fortinet-device, ios-device, windows-device.
    comment String
    Comment.
    dynamicSortSubtable 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 ].
    getAllTables 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.
    mac String
    Device MAC address.
    masterDevice String
    Master device (optional).
    taggings List<Property Map>
    Config object tagging. The structure of tagging block is documented below.
    type String
    Device type. Valid values: unknown, android-phone, android-tablet, blackberry-phone, blackberry-playbook, forticam, fortifone, fortinet-device, gaming-console, ip-phone, ipad, iphone, linux-pc, mac, media-streaming, printer, router-nat-device, windows-pc, windows-phone, windows-tablet, other-network-device.
    user String
    User 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.

    Supporting Types

    DeviceTagging, DeviceTaggingArgs

    Category string
    Tag category.
    Name string
    Tagging entry name.
    Tags List<Pulumiverse.Fortios.User.Inputs.DeviceTaggingTag>
    Tags. The structure of tags block is documented below.
    Category string
    Tag category.
    Name string
    Tagging entry name.
    Tags []DeviceTaggingTag
    Tags. The structure of tags block is documented below.
    category String
    Tag category.
    name String
    Tagging entry name.
    tags List<DeviceTaggingTag>
    Tags. The structure of tags block is documented below.
    category string
    Tag category.
    name string
    Tagging entry name.
    tags DeviceTaggingTag[]
    Tags. The structure of tags block is documented below.
    category str
    Tag category.
    name str
    Tagging entry name.
    tags Sequence[DeviceTaggingTag]
    Tags. The structure of tags block is documented below.
    category String
    Tag category.
    name String
    Tagging entry name.
    tags List<Property Map>
    Tags. The structure of tags block is documented below.

    DeviceTaggingTag, DeviceTaggingTagArgs

    Name string
    Tag name.
    Name string
    Tag name.
    name String
    Tag name.
    name string
    Tag name.
    name str
    Tag name.
    name String
    Tag name.

    Import

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

    $ pulumi import fortios:user/device:Device labelname {{alias}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/device:Device labelname {{alias}}
    

    $ 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