Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.6
Download PDF
Copy Link

user device-group

Use this command to edit or define FortiGate default or custom device groups.

config user device-group
    edit {name}
    # Configure device groups.
        set name {string}   Device group name. size[35]
        config member
            edit {name}
            # Device group member.
                set name {string}   Device name. size[35] - datasource(s): user.device.alias,user.device-category.name
            next
        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 comment {string}   Comment. size[255]
    next
end

Additional information

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

member

This setting contains a table of the devices or members that belong to the group.

This setting can be prefaced with the following options

  • set - whichever members are listed when using this command are the only ones that are included in the group
  • Syntax: set member <member1> <member2>...
  • append - any members included in the command when using append will be added to the existing list of members
  • Syntax: append member <member3> <member4>...
  • clear - removes all members from the group
  • Syntax: clear member

When adding multiple members, each member should be separated by a space (see the full default list of device categories).

user device-group

Use this command to edit or define FortiGate default or custom device groups.

config user device-group
    edit {name}
    # Configure device groups.
        set name {string}   Device group name. size[35]
        config member
            edit {name}
            # Device group member.
                set name {string}   Device name. size[35] - datasource(s): user.device.alias,user.device-category.name
            next
        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 comment {string}   Comment. size[255]
    next
end

Additional information

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

member

This setting contains a table of the devices or members that belong to the group.

This setting can be prefaced with the following options

  • set - whichever members are listed when using this command are the only ones that are included in the group
  • Syntax: set member <member1> <member2>...
  • append - any members included in the command when using append will be added to the existing list of members
  • Syntax: append member <member3> <member4>...
  • clear - removes all members from the group
  • Syntax: clear member

When adding multiple members, each member should be separated by a space (see the full default list of device categories).