Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.0
Download PDF
Copy Link

user device

Use this command to define and configure host devices.

History

The following table shows all newly added, changed, or removed entries as of FortiOS 6.0.

Command Description

set category {amazon-device | ...}

New Amazon device type category.

config user device
    edit {alias}
    # Configure devices.
        set alias {string}   Device alias. size[35]
        set mac {mac address}   Device MAC address.
        set user {string}   User name. size[64]
        set master-device {string}   Master device (optional). size[35] - datasource(s): user.device.alias
        set comment {string}   Comment. size[255]
        set avatar {string}   Image file for avatar (maximum 4K base64 encoded). size[4095]
        config tagging
            edit {name}
            # Config object tagging.
                set name {string}   Tagging entry name. size[63]
                set category {string}   Tag category. size[63] - datasource(s): system.object-tagging.category
                config tags
                    edit {name}
                    # Tags.
                        set name {string}   Tag name. size[64] - datasource(s): system.object-tagging.tags.name
                    next
            next
        set type {option}   Device type.
                unknown               Device type not yet determined.
                android-phone         Android-based phones.
                android-tablet        Android-based tablets.
                blackberry-phone      BlackBerry phones.
                blackberry-playbook   BlackBerry tablets.
                forticam              FortiCam.
                fortifone             FortiFone.
                fortinet-device       Other Fortinet devices.
                gaming-console        Gaming consoles (Xbox, PS2, PS3, Wii, PSP).
                ip-phone              VoIP phones.
                ipad                  iPad Tablets.
                iphone                iPhone and iPod Touch devices.
                linux-pc              Linux PC.
                mac                   Mac computers.
                media-streaming       Other media streaming devices.
                printer               Printing devices.
                router-nat-device     Router and/or NAT devices.
                windows-pc            Windows PC.
                windows-phone         Windows-based phones.
                windows-tablet        Windows-based tablets.
                other-network-device  All other identified devices.
        set category {option}   Device category.
                none               No specific category.
                amazon-device      Amazon devices.
                android-device     Android devices.
                blackberry-device  BlackBerry devices.
                fortinet-device    Fortinet devices.
                ios-device         Devices running Apple iOS.
                windows-device     Devices running Microsoft Windows.
    next
end

Additional information

The following section is for those options that require additional explanation.

append tags <tag-name>

Append applied object tags.

avatar <image-file>

Enter an image file name to be used as the user's avatar (maximum 4K base64 encoded).

comment [string]

Optional comments.

mac <mac-address>

Enter the device's MAC address.

master-device [name]

Optionally enter a master device name.

tags <image-file>

Enter applied object tags.

type <device-type>

Select the device type from the following:

  • 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 <name>

Enter the device owner's user name.

user device

Use this command to define and configure host devices.

History

The following table shows all newly added, changed, or removed entries as of FortiOS 6.0.

Command Description

set category {amazon-device | ...}

New Amazon device type category.

config user device
    edit {alias}
    # Configure devices.
        set alias {string}   Device alias. size[35]
        set mac {mac address}   Device MAC address.
        set user {string}   User name. size[64]
        set master-device {string}   Master device (optional). size[35] - datasource(s): user.device.alias
        set comment {string}   Comment. size[255]
        set avatar {string}   Image file for avatar (maximum 4K base64 encoded). size[4095]
        config tagging
            edit {name}
            # Config object tagging.
                set name {string}   Tagging entry name. size[63]
                set category {string}   Tag category. size[63] - datasource(s): system.object-tagging.category
                config tags
                    edit {name}
                    # Tags.
                        set name {string}   Tag name. size[64] - datasource(s): system.object-tagging.tags.name
                    next
            next
        set type {option}   Device type.
                unknown               Device type not yet determined.
                android-phone         Android-based phones.
                android-tablet        Android-based tablets.
                blackberry-phone      BlackBerry phones.
                blackberry-playbook   BlackBerry tablets.
                forticam              FortiCam.
                fortifone             FortiFone.
                fortinet-device       Other Fortinet devices.
                gaming-console        Gaming consoles (Xbox, PS2, PS3, Wii, PSP).
                ip-phone              VoIP phones.
                ipad                  iPad Tablets.
                iphone                iPhone and iPod Touch devices.
                linux-pc              Linux PC.
                mac                   Mac computers.
                media-streaming       Other media streaming devices.
                printer               Printing devices.
                router-nat-device     Router and/or NAT devices.
                windows-pc            Windows PC.
                windows-phone         Windows-based phones.
                windows-tablet        Windows-based tablets.
                other-network-device  All other identified devices.
        set category {option}   Device category.
                none               No specific category.
                amazon-device      Amazon devices.
                android-device     Android devices.
                blackberry-device  BlackBerry devices.
                fortinet-device    Fortinet devices.
                ios-device         Devices running Apple iOS.
                windows-device     Devices running Microsoft Windows.
    next
end

Additional information

The following section is for those options that require additional explanation.

append tags <tag-name>

Append applied object tags.

avatar <image-file>

Enter an image file name to be used as the user's avatar (maximum 4K base64 encoded).

comment [string]

Optional comments.

mac <mac-address>

Enter the device's MAC address.

master-device [name]

Optionally enter a master device name.

tags <image-file>

Enter applied object tags.

type <device-type>

Select the device type from the following:

  • 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 <name>

Enter the device owner's user name.