Fortinet black logo

Administration Guide

Meta Fields

Meta Fields

Meta fields allow administrators to add extra information when configuring, adding, or maintaining FortiGate units or adding new administrators. You can make meta fields required or optional.

When meta fields are required, administrators must supply additional information when they create an associated object. For example, if you create a required meta field for a device object, administrators must define a value for the meta field for all devices.

When you create a meta field, a variable for the meta field is automatically created. You can use the variable in interface templates.

Go to System Settings > Advanced > Meta Fields to configure meta fields. Meta fields can be added, edited, and deleted.

Select Expand All or Collapse All from the toolbar or right-click menu to view all or none of the meta fields under each object.

To create a new meta field:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Click Create New in the toolbar. The Create New Meta Field pane opens.

  3. From the Object field, select an object.

    Some objects also allow you to define a value for the meta field for each device.

    Object

    The object this metadata field applies to: Administrative Domain, Central NAT, Device, Device Group, Device VDOM, Chassis, Firewall Addresses, Firewall Address Group, Firewall Policy, Firewall Service, Firewall Service Group, and System Administrator.

  4. Configure the following settings:

    Name

    Enter the label to use for the field.

    When you type the name, a variable name is automatically created.

    You can use the variable in provisioning templates.

    Length

    Select the maximum number of characters allowed for the field from the dropdown list: 20, 50, or 255.

    Importance

    Select Required to make the field compulsory; otherwise, select Optional.

    Status

    Select Disabled to disable this field. The default selection is Enabled.

    This field is only available for non-firewall objects.

  5. If you selected a Device or Device VDOM object, set a value for the meta field:
    1. Under Values, click Create New.

      The Create Meta Field Value dialog box is displayed.

    2. From the Device list, select a device.
    3. In the Value box, type a value for the device.
    4. Click OK.

      The value is defined for the device.

  6. Click OK.

    The meta field is created.

To edit a meta field:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Double-click on a field, right-click on a field and then select Edit from the menu, or select a field then click Edit in the toolbar. The Edit Meta Fields pane opens.
  3. Edit the settings as required, and then click OK to apply the changes.

The Object and Name fields cannot be edited.

To delete a meta field or fields:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Select the field or fields you need to delete.
  3. Click Delete in the toolbar, or right-click and select Delete.
  4. Click OK in the confirmation box to delete the field or fields.

The default meta fields cannot be deleted.

Meta Fields

Meta fields allow administrators to add extra information when configuring, adding, or maintaining FortiGate units or adding new administrators. You can make meta fields required or optional.

When meta fields are required, administrators must supply additional information when they create an associated object. For example, if you create a required meta field for a device object, administrators must define a value for the meta field for all devices.

When you create a meta field, a variable for the meta field is automatically created. You can use the variable in interface templates.

Go to System Settings > Advanced > Meta Fields to configure meta fields. Meta fields can be added, edited, and deleted.

Select Expand All or Collapse All from the toolbar or right-click menu to view all or none of the meta fields under each object.

To create a new meta field:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Click Create New in the toolbar. The Create New Meta Field pane opens.

  3. From the Object field, select an object.

    Some objects also allow you to define a value for the meta field for each device.

    Object

    The object this metadata field applies to: Administrative Domain, Central NAT, Device, Device Group, Device VDOM, Chassis, Firewall Addresses, Firewall Address Group, Firewall Policy, Firewall Service, Firewall Service Group, and System Administrator.

  4. Configure the following settings:

    Name

    Enter the label to use for the field.

    When you type the name, a variable name is automatically created.

    You can use the variable in provisioning templates.

    Length

    Select the maximum number of characters allowed for the field from the dropdown list: 20, 50, or 255.

    Importance

    Select Required to make the field compulsory; otherwise, select Optional.

    Status

    Select Disabled to disable this field. The default selection is Enabled.

    This field is only available for non-firewall objects.

  5. If you selected a Device or Device VDOM object, set a value for the meta field:
    1. Under Values, click Create New.

      The Create Meta Field Value dialog box is displayed.

    2. From the Device list, select a device.
    3. In the Value box, type a value for the device.
    4. Click OK.

      The value is defined for the device.

  6. Click OK.

    The meta field is created.

To edit a meta field:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Double-click on a field, right-click on a field and then select Edit from the menu, or select a field then click Edit in the toolbar. The Edit Meta Fields pane opens.
  3. Edit the settings as required, and then click OK to apply the changes.

The Object and Name fields cannot be edited.

To delete a meta field or fields:
  1. Go to System Settings > Advanced > Meta Fields.
  2. Select the field or fields you need to delete.
  3. Click Delete in the toolbar, or right-click and select Delete.
  4. Click OK in the confirmation box to delete the field or fields.

The default meta fields cannot be deleted.