Fortinet Document Library

Version:


Table of Contents

New Features

7.0.0
Download PDF
Copy Link

Add options for API Preview, Edit in CLI, and References

The Additional Information section in the right-side gutter of the GUI includes the following buttons:

  • API Preview: view all REST API requests being used by the page. Users can make changes on the page that are reflected in the API request preview. This button is not available if the user is logged in as an administrator that has read-only GUI permissions.
  • Edit in CLI: open a CLI console window to view and edit the setting in the CLI. If there are multiple CLI settings on the page, the CLI console shows the first setting. This option is applicable for edit pages.
  • References: open the object usage page to show which other configuration are referencing the object. This option is applicable for edit object pages.

API Preview

These examples use the API Preview when configuring firewall address objects.

To use the API Preview with a new object:
  1. Go to Policy & Objects > Addresses and click Create New > Address.
  2. Enter the address settings.

  3. Click API Preview. The API Preview pane opens, and the inputted data for the name, color, and IP/netmask are visible (data). Since a new object is being created, the POST request is shown for the CMDB API that creates the firewall address object.
  4. Enable Show modified changes only to show the modified changes instead of the full configuration in the preview.
  5. Click Close and edit the address settings.
  6. Click API Preview. The name, color, and IP/netmask are updated in the preview.

    If this option is disabled, the entire object information is displayed.

  7. Click Copy to Clipboard to copy the JSON code shown on the preview screen to the clipboard.
  8. Click Close to leave the preview.
To use the API Preview with an existing object:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click API Preview. The API Preview pane opens, and the input is visible under data. Since an existing object is being edited, the PUT request is shown for the CMDB API that edits the firewall address object.

A prompt, No changes have been made, appears in cases where no changes are made, such in the following AV profile.

Edit in CLI

This example uses the Edit in CLI option to edit an existing firewall address.

To use the Edit in CLI option:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click Edit in CLI.

    A console tab opens. The address configuration displays and can be modified.

References

This example uses the References option to view which configurations reference an existing firewall address.

To use the References option:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click References. A pane opens with information about the current and possible usage of the address.
  3. Click the Current Usage or Possible Uses buttons to view more information.

Add options for API Preview, Edit in CLI, and References

The Additional Information section in the right-side gutter of the GUI includes the following buttons:

  • API Preview: view all REST API requests being used by the page. Users can make changes on the page that are reflected in the API request preview. This button is not available if the user is logged in as an administrator that has read-only GUI permissions.
  • Edit in CLI: open a CLI console window to view and edit the setting in the CLI. If there are multiple CLI settings on the page, the CLI console shows the first setting. This option is applicable for edit pages.
  • References: open the object usage page to show which other configuration are referencing the object. This option is applicable for edit object pages.

API Preview

These examples use the API Preview when configuring firewall address objects.

To use the API Preview with a new object:
  1. Go to Policy & Objects > Addresses and click Create New > Address.
  2. Enter the address settings.

  3. Click API Preview. The API Preview pane opens, and the inputted data for the name, color, and IP/netmask are visible (data). Since a new object is being created, the POST request is shown for the CMDB API that creates the firewall address object.
  4. Enable Show modified changes only to show the modified changes instead of the full configuration in the preview.
  5. Click Close and edit the address settings.
  6. Click API Preview. The name, color, and IP/netmask are updated in the preview.

    If this option is disabled, the entire object information is displayed.

  7. Click Copy to Clipboard to copy the JSON code shown on the preview screen to the clipboard.
  8. Click Close to leave the preview.
To use the API Preview with an existing object:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click API Preview. The API Preview pane opens, and the input is visible under data. Since an existing object is being edited, the PUT request is shown for the CMDB API that edits the firewall address object.

A prompt, No changes have been made, appears in cases where no changes are made, such in the following AV profile.

Edit in CLI

This example uses the Edit in CLI option to edit an existing firewall address.

To use the Edit in CLI option:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click Edit in CLI.

    A console tab opens. The address configuration displays and can be modified.

References

This example uses the References option to view which configurations reference an existing firewall address.

To use the References option:
  1. Go to Policy & Objects > Addresses and double-click an address to edit it.
  2. Click References. A pane opens with information about the current and possible usage of the address.
  3. Click the Current Usage or Possible Uses buttons to view more information.