Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Filter Management in Junos Space Platform User Interface

    This section contains the following topics:

    Understanding Filtering Options in Junos Space Platform User Interface

    This topic contains the following sections:

    Overview

    On various Junos Space Platform pages, you can use the Filter menu to show or hide table entries based on the filtering criteria that you specify. Filters enable you to quickly find and evaluate the entries that are relevant to your specific needs.

    Many of the columns in Junos Space page tables support filtering. To know whether or not a column supports filtering of data, click the down arrow next to the column name. If the Filter submenu appears, then that column supports filtering of data. The filtering criteria that are available for you depend on the selected column. You can create filters that combine criteria from more than one column.

    From Release 17.2R1 onward, Junos Space Platform introduces the following enhancements to filtering options:

    • Ability to save, modify, and delete filters
    • Ability to share saved filters with other users
    • Ability to mark filters as favorites
    • Ability to manually enter filter conditions with autocomplete and suggestion support.

    For a list of pages and columns that support filtering, see Pages and Columns that Support Filtering.

    In releases earlier than 17.2R1, Junos Space Platform supports only basic filtering. In those releases, you can specify only one set of filter criteria at a time, and the filter setting is lost when you modify the criteria. From Junos Space Platform Release 17.2R1 onward, you can save multiple filters. You can also mark up to 10 filters as favorites in each of the pages that support enhanced filtering.

    The Filter menu that appears when you click the filter icon lists up to 10 filters. The 10 filters that are listed in the Filter menu are arranged in the following order of filter categories: favorite filters, public filters, and private filters. If there are more than 10 filters, those filters are listed under the More Filters submenu.

    Note: The More Filters submenu is not displayed if you have not saved any filter. However, the More Filters submenu appears even if you have saved only one filter.

    If you have Filter Management permissions to create or modify filters, you can also choose to share the saved filters with other users by marking the filters as public.

    For more information about creating, saving, modifying, and deleting filters, see Managing Filtering Options.

    From Junos Space Platform Release 17.2R1, you can also manually enter filter criteria in the filter text box that appears when you click the Show/ Clear and Hide Filters option from the Filter menu. For more information about manually specifying filter criteria, see Managing Filtering Options.

    Benefits

    Filters enable you to quickly find and evaluate the entries that are relevant to your specific needs. Ability to save and share filters enables you to configure multiple filters for a page that can be preserved across sessions and shared with multiple users.

    Pages and Columns that Support Filtering

    This section contains the following topics:

    Pages and Columns that Support Enhanced Filtering

    The following table lists the pages and columns that support enhanced filtering and also the data types for each of the columns:

    Page

    Column

    Data Type

    Device Management

    Name

    String

    Device Alias

    String

    IP Address

    Number

    Serial Number

    String

    Connection Status

    List

    Managed Status

    List

    Platform

    String

    OS Version

    String

    Domain

    String

    Device Family

    String

    Configuration State

    List

    Last Rebooted Time

    Date

    Vendor

    String

    Authentication Status

    String

    Aggregation Device

    String

    Satellite Devices

    String

    Device Network

    List

    View Physical Interfaces

    Physical Interface Name

    String

    IP Address

    String

    IPv6 Address

    String

    MAC Address

    String

    Operational Status

    List

    Admin Status

    List

    Link Level Type

    String

    Link Type

    String

    Speed

    String

    MTU

    String

    Description

    String

    Domain

    String

    View Logical Interfaces

    Interface Name

    String

    IP Address

    String

    IPv6 Address

    String

    Description

    String

    Domain

    String

    Device Discovery Profiles

    Profile Name

    String

    Target Type

    List

    Target Details

    String

    Profile Visibility

    List

    Job ID

    Number

    Model Devices

    Name

    String

    Description

    String

    Devices Count

    Number

    Device Adapter

    Name

    String

    Device Family

    String

    Version

    String

    Adapter State

    List

    Template Definitions

    Name

    String

    Domain

    String

    Description

    String

    Last Modified By

    String

    Templates

    Name

    String

    Domain

    String

    Template Type

    List

    Latest Version

    String

    Description

    String

    Last Modified By

    String

    Deployment Status

    List

    Configlets

    Name

    String

    Domain

    String

    Category

    String

    Device Family Series

    List

    Latest Version

    String

    Git Version

    String

    Git Branch

    String

    Execution Type

    List

    Creation Time

    Date

    Last Updated Time

    Date

    Last Modified By

    String

    Reference Number

    Number

    Configuration View

    Name

    String

    Domain

    String

    Title

    String

    Device Family Series

    List

    View Type

    List

    Creation Time

    Date

    Last Updated Time

    Date

    Last Modified By

    String

    Configuration Filter

    Name

    String

    Domain

    String

    Device Family Series

    List

    Xpath and Regex

    Name

    String

    Domain

    String

    Value

    String

    Property Type

    List

    Creation Time

    Date

    Last Updated Time

    Date

    Last Modified By

    String

    Images

    File Name

    String

    Domain

    String

    Version

    String

    Type

    List

    Scripts

    Script Name

    String

    Domain

    String

    Descriptive Name

    String

    Type

    List

    Category

    String

    Execution Type

    String

    Format

    List

    Latest Revision

    String

    Git Version

    String

    Git Branch

    String

    Operations

    Operation Name

    String

    Domain

    String

    Description

    String

    Creation Time

    Date

    Last Updated Time

    Date

    Script Bundles

    Script Bundle Name

    String

    Domain

    String

    Config Files Management

    Config File Name

    String

    Device Name

    String

    Device Alias

    String

    Latest ConfigFile Version

    String

    Creation Date

    Date

    Last Updated Date

    Date

    Job Management

    ID

    Number

    Domain

    String

    Name

    String

    Percent

    Number

    State

    List

    Job Type

    String

    Parameters

    String

    Summary

    String

    Scheduled Start Time

    Date

    Actual Start Time

    Date

    End Time

    Date

    Owner

    String

    Retry Group Id

    Number

    Previous Retry

    Number

    User Accounts

    User Name

    String

    First Name

    String

    Last Name

    String

    Email

    String

    User Type

    List

    Status

    List

    GUI/API Access

    List

    Locked Out

    List

    Roles

    Role Title

    String

    Type

    List

    Description

    String

    User Sessions

    User Name

    String

    IP Address

    String

    Fabric Node Name

    String

    Session Start Time

    Date

    Audit Log

    ID

    Number

    User Name

    String

    User IP

    String

    Domain

    String

    Application

    String

    Task

    String

    Timestamp

    Date

    Result

    String

    Description

    String

    Job ID

    Number

    Fabric

    Last Monitored Time

    Date

    Last Boot Time

    Date

    Audit Log Forwarding

    Name

    String

    Description

    String

    Server Address

    String

    Port

    Number

    Protocol

    List

    Last Updated User

    String

    Last Updated Time

    Date

    Enabled

    List

    Tags

    Name

    String

    Owner

    String

    Description

    String

    Access Type

    List

    Report Definitions

    Name

    String

    Domain

    String

    Created By

    String

    Created Time

    Date

    Description

    String

    Generated Reports

    Name

    String

    Generated Time

    Date

    Domain

    String

    Description

    String

    Definition Name

    String

    Generated By

    String

    Format

    String

    Job ID

    Number

    Pages That Support Basic Filtering

    Junos Space Platform supports basic filtering options on the following pages:

    • Role Based Access Control > Domains
    • Administration > CA/CRL Certificates
    • Administration > SMTP Servers
    • Administration > DMI Schemas

      Note: Filtering is supported only for the State and Schema Installed columns.

    Managing Filtering Options

    From Junos Space Platform 17.2R1 onward, you can save filters, modify the saved filters, and delete the filters. You can also mark the filters as public or favorites or both. The following sections explain the various filter management tasks that you can perform from the Junos Space Platform user interface (UI):

    Creating Filters by Manually Entering the Filter Criteria

    From Junos Space Platform Release 17.2R1 onward, you can manually enter the filtering criteria to create the filters that meet your specific requirements.

    To manually enter filtering criteria:

    1. From any of the pages that support Filter Management options, click the Filter icon.

      The Filter menu appears.

    2. Click Show/ Clear and Hide Filters on the Filter menu.

      The Filter field appears.

    3. Click inside the Filter field.

      A list showing the names of columns that support filtering and the following two options appears:

      • An opening parenthesis [ ( ] symbol. The bracket enables you to group conditions. A closing parenthesis [ ) ] symbol appears in the list after you specify a condition if you used an opening parenthesis before specifying the condition.
      • Not. The Not option enables you to specify conditions based on which you want to filter out entries.
    4. From the list, select the columns for which you want to specify the filter conditions and specify the conditions by using any of the operators supported for the specified column. Table 1 lists various operators that you can use for each of the data types supported for filtering.

      You can specify multiple conditions by using an AND or an OR operator. The Filter field supports autocomplete and provides suggestions for column names, attributes, and operators even as you type inside the field.

      Note: If the values you enter for any of the parameters contain spaces, enclose such values in single quotation marks. For example, Domain Contains 'test domain'. However, if the single quotation mark is part of the search string, use the backslash escape character (\) before the quotation mark. For example: Domain Contains '\'test domain\''.

      Table 1: Data Types and Supported Operators

      Data Type

      Supported Operators

      String (Other than Domain Column)

      Starts-with

      Ends- with

      Contains

      =

      !=

      String (Domain Column only)

      Contains

      Not-contains

      Numbers or Date

      =

      !=

      >

      <

      <=

      >=

      List

      =

      !=

      The following examples show samples of manually entered filter criteria:

      • ID > 2000000 AND 'Job Type' ends-with 'elements' AND Parameters contains '1.1.1.1' OR Parameters = 192.168.27.72 AND Owner = SUPER

        This filter on the Job page displays jobs that meet the following criteria: The job ID is a number greater than 2000000, the job type ends with the text elements, the Parameter field contains 1.1.1.1 or 192.168.27.72, and the owner is the superuser.

      • ( 'Connection Status' = 'down' ) AND ('Managed Status' = 'In Sync' OR 'Managed Status' = Synchronizing ) AND 'Device Family' starts-with 'junos'

        This filter on the Device page displays devices that have the connection status set to down, the managed status set to in sync or synchronizing, and device family name starts with Junos.,

    5. After you enter the conditions, you can save or apply the filter. To save the filter, click the Save Filter icon and complete the steps as explained in Saving a Filter. To apply the filter without saving, click the Apply Filter icon. For more information about applying filters, see Applying a Filter.

      To clear the filter conditions you entered or the filter that you applied, click the Clear Filter icon. Alternatively, you can click the Clear and and Hide icon to clear the filters and hide the filter bar.

    For a list of error messages, see Error Conditions and Error Messages for Filters.

    Creating Filters by Using the Filter Submenu Options

    Many of the columns in Junos Space user interface tables support filtering. To know whether or not a column supports filtering of data, click the down arrow next to the column name. If the Filter submenu appears, then that column supports filtering of data. The criteria that are available for you to filter on depend on the selected column. You can create filters that combine criteria from more than one column.

    On Junos Space pages that support enhanced filtering options, the Filter field and the Save Filter, Apply Filter, and Clear Filter icons appear when you select any of the items from the Filter submenu. The selected criteria are displayed in the Filter field. You can choose to apply, save, or clear the filtering criteria by clicking the appropriate icon.

    On Junos Space pages that do not support enhanced filtering options, when you select any of the items from the Filter submenu, Junos Space Platform displays the filter criteria, including the columns being filtered, above the table. Junos Space Platform displays a red X to the left of the filter criteria above the table. You can clear the filter and restore the table to its original view by clicking the X.

    Figure 1 shows a typical Filter submenu for a date column.

    Figure 1: Typical Submenu for a Date Column

    Typical Submenu for
a Date Column

    The following procedures describe how to use the different types of available filters.

    To filter entries on the Junos Space pages:

    1. On the Junos Space Platform UI, click the down arrow on the column header and select Filters.

      The Filters submenu appears, displaying the list of operators or values that you can select, based on the type of values in the column.

    2. Based on the submenu that appears, perform one of the following procedures.

      To specify filters for a date field:

      1. From the Filter submenu, select Before, After, or On.

        You can select both Before and After dates and times to filter the entries by a specific time period. You can also select On to view events recorded on a specific date.

      2. Click the calendar icon and select the date from the calendar.

        You can click Today to view the events that occurred today at the specified time.

      3. Click the arrow beside the time list and select the time.

      To specify filters for a text field:

      1. In the text box that appears, type the alphanumeric string based on which you want to filter entries.

      To specify filters for a field with discrete values such as Success or Failure, or True or False:

      1. From the list of values that appears, select the check boxes for one or more values based on which you want to filter entries.

      To specify filters for a numeric field:

      1. Enter values for each operator that you want to specify.
    3. Click Go to view the entries filtered based on the criteria that you specified.
    4. On pages that support enhanced filtering options, you can choose to save the filter after you specify the required criteria. To save the filter, click the Save Filter icon and complete the steps as explained in Saving a Filter. To apply the filter without saving, click the Apply Filter icon. For more information about applying filters, see Applying a Filter.

      To clear the filter conditions you entered or the filter that you applied, click the Clear Filter icon.

    You can also filter entries based on combined filters with different criteria specified for different columns. For example, you can filter for all events on a certain date whose status was success. When you use multiple filters, the filters are joined using the logical AND operator.

    To clear only the part of a filter that applies to a any of the columns, click the down arrow on the column header and clear the check box next to Filter.

    Saving a Filter

    You can create a filter either by using the filtering options that are available in the Junos Space Platform UI or by manually entering the filter criteria in the Filter field that appears when you click the Filter icon. After you specify the filtering criteria, you can save the filter.

    To save a filter:

    1. Create a filter as explained in either of the following topics:

      The criteria you specified, either by typing in the Filter field or by using the Filter submenu options in the Junos Space Platform UI, appear in the Filter field.

    2. Click the Save Filter icon next to the Filter field.

      The Save Filter page appears.

    3. In the Name field, enter a name for the filter.
    4. (Optional) In the Description field, enter a description for the filter.
    5. (Optional)To share the filter with other users, select the Make Public check box.

      Note: You cannot change a public filter to a private filter after you save the changes. However, you can change a private filter to a public filter from the Modify Filters page.

    6. (Optional) If you want to mark the filter as a favorite, select the Mark as Favorite check box.

      Alternatively, you can add a filter to the list of favorites or remove a filter from the list of favorites from the Manage Filters page.

    7. Click Save to save the filter. To close the page without saving the filter, click Cancel.

    Modifying a Filter

    From the Manage Filters page. you can modify saved filters.

    1. From the Junos Space Platform UI, go to the page that contains the filter that you want to modify. For example, the Device Management or View Physical Devices page.
    2. Click the Filter icon to view the Filter menu.
    3. From the Filter menu, click Manage Filters.

      The Manage Filters page appears.

    4. From the list of filters, click the filter entry that you want to modify.

      The selected filter entry appears highlighted.

    5. Modify the following parameters as required:
      • Name–The name of the filter.
      • Description–Description for the filter.
      • Filter Criteria–Filter criteria to apply for the filter. For information about manually entering the filter criteria, see Creating Filters by Manually Entering the Filter Criteria.
      • Make Public–Specify whether the filter is a public filter. Public filters are available for all users. However, note that only users with Filter Management permissions to create or modify filters can create public filters. This check box is disabled if the selected filter is a Public filter. That is, you cannot clear this check box after you select this check box and save the filter.

        Note: To create a public filter, you must have both Create Filter and Modify Filter roles assigned to your account.

      • Mark as Favorite–Specify whether the filter is a favorite or not. You can select this check box to mark the selected filter as favorite. To remove a filter from the list of favorites, clear this check box. Favorite filters are listed on top of the Filter menu options. If there are favorite filters and filters that are not marked as favorites, the filters that are not marked as favorites appear in the More Filters submenu.
    6. Click Modify to save the changes. Click Reset if you want to discard the changes.

    For a list of error messages, see Error Conditions and Error Messages for Filters.

    Creating a Public Filter

    Public filters are filters that are available to all users. To create a public filter, you must have both Create Filter and Modify Filter roles assigned to your account. Junos Space Platform adds the suffix (Public) to the names of filters that are made public.

    To make a filter public:

    1. When you save a filter, select the Make Public check box. For more information about saving filters, see Saving a Filter.
    2. When you modify a filter, select the Make Public check box. For more information about modifying filters, see Modifying a Filter

    Note: After you make a filter public, you cannot change that to a private filter.

    Applying a Filter

    Junos Space Platform provides you multiple options to apply a filter.

    • From pages that support enhanced filtering, you can apply a filter by clicking the name of the filter from the Filter menu. Alternatively, while creating a filter, you can click the Apply Filter icon (the green tick mark) next to the Filter field.
    • From pages that do not support enhanced filtering, you can apply a filter by selecting and specifying filter options from the Filter submenu available for columns that support filtering and then clicking Go.

    Clearing a Filter

    Junos Space Platform provides you the following options to clear a filter that is applied to a page.

    • On Junos Space pages that support enhanced filtering options, if a filter is applied to the page, the filter criteria is displayed in the Filter field. You can click the Clear Filter icon to clear the applied filter. Alternatively, you can click the Clear and Hide Filters icon from the Filter bar or the Show/Clear and Hide item in the Filter menu.
    • On Junos Space pages that do not support enhanced filtering options, when you select any of the items from the Filter submenu, Junos Space Platform displays the filter criteria, including the columns being filtered, above the table. Junos Space Platform displays a red X icon to the left of the filter criteria above the table. You can clear the filter and restore the table to its original view by clicking the X icon.

    Deleting a Filter

    From the Manage Filters page. you can delete saved filters.

    To delete a saved filter:

    1. From the Junos Space Platform UI, go to the page that contains the filter that you want to delete. For example, the Device Management or View Physical Devices page.
    2. Click the Filter icon to view the Filter menu.
    3. From the Filter menu, click Manage Filters.

      The Manage Filters page appears.

    4. From the list of filters, click the filter entry that you want to delete.

      The selected filter entry appears highlighted.

    5. Click the Delete icon above the top-left corner of the list of filters.

      The Delete Filter page appears.

    6. On the Delete Filter page, click OK. Click Cancel if you do not want to delete the selected filter.

    Error Conditions and Error Messages for Filters

    The following table lists common error conditions you might encounter while saving or applying filters and the error messages for those conditions:

    Table 2: Error Conditions and Error Messages for Filters

    Error Condition

    Sample Filter Data

    Validation Error Message at Apply Filter

    Validation Error Message on the Save Filter and Manage Filter Page

    Invalid column name.

    'namm'

    Invalid column name: namm

    Invalid filter query

    Incorrect filter query. Comparison missing after column name.

    'Name' juniper

    'Name' has test OR 'Device Alias' contains test

    Incorrect filter query, please provide a comparison after column name (Name)

    Invalid filter query

    Incorrect filter query. Value after comparison missing.

    Name =

    Name =  juniper OR Name =

    Incorrect filter query, please provide a value after comparison (=)

    Invalid filter query

    Incorrect filter query; “)” missing.

    ( Name = test

    Incorrect filter query, please insert ")" to complete the query (test)

    Invalid filter query

    Incomplete filter query. Column name or "(" missing.

    ( Name =  juniper ) OR

    Incomplete filter query. Please provide a column name or "(" to complete the query after (OR)

    Invalid filter query

    Incomplete filter query. Column name or "(" missing after (NOT)

    ( Name =  juniper ) OR NOT

    Incomplete filter query. Please provide a column name or "(" to complete the query after(NOT)

    Invalid filter query

    Incorrect filter query; Unexpected token ")"

    Name = test )

    Incorrect filter query, Unexpected token ")"

    Invalid filter query

    Incorrect filter query; Unexpected token ")"

    Name = test  AND ( Name = test1))

    Incorrect filter query, Unexpected token ")"

    Invalid filter query

    Incorrect filter query; Unexpected token "("

    Name = test  AND ( Name = test1)(

    Incorrect filter query, Unexpected token "("

    Invalid filter query

    Incorrect filter query; ")" missing.

    ( Name = test  AND ( Name = test1)

    Incorrect filter query, please insert ")" to complete the query (test)

    Invalid filter query

    Invalid filter query. Query must start with "(" or NOT or column name.

    )

    Invalid filter query. Query should start with "(" or NOT or column name.

    Invalid filter query

    Invalid filter query

    ( Name starts-with ")

    Invalid filter query. Query should start with "(" or NOT or column name.

    Invalid filter query

    The equal condition is not supported for the specified column.

    Domain = SUCCESS

    Filtering of “Domain” column is not possible with “Equal” condition

    The not equal condition is not supported for the specified column.

    Domain != SUCCESS

    Filtering of “Domain” column is not possible with “Not Equal” condition

    The greater than condition is not supported for the specified column.

    Name > Test

    Filtering of “Name” column is not possible with “Greater than” condition

    Filtering of “Name” column is not possible with “Greater than” condition

    The less than condition is not supported for the specified column.

    Name < Test

    Filtering of “Name” column is not possible with “Less than” condition

    Filtering of “Name” column is not possible with “Less than” condition

    The “greater than or equal to” condition is not supported for the specified column.

    Name >= Test

    Filtering of “Name” column is not possible with “Greater than or equal to” condition

    Filtering of “Name” column is not possible with “Greater than or equal to” condition

    The “Less than or equal to” condition is not supported for the specified column.

    Name <= Test

    Filtering of “Name” column is not possible with “Less than or equal to” condition

    Filtering of “Name” column is not possible with “Less than or equal to” condition

    The “contains” condition is not supported for the specified column.

    ID contains 123

    Filtering of “ID” column is not possible with “contains” condition

    Filtering of “ID” column is not possible with “contains” condition

    The “not-contains” condition is not supported for the specified column.

    ID not-contains 123

    Filtering of “ID” column is not possible with “not-contains” condition

    Filtering of “ID” column is not possible with “not-contains” condition

    The “starts-with” condition is not supported for the specified column.

    ID starts-with 123

    Filtering of “ID” column is not possible with “starts-with” condition

    Filtering of “ID” column is not possible with “starts-with” condition

    The “ends-with” condition is not supported for the specified column.

    ID ends-with 123

    Filtering of “ID” column is not possible with “ends-with” condition

    Filtering of “ID” column is not possible with “ends-with' condition

    The specified column supports only numbers for values.

    ID = test

    “ID” column accepts only Numbers

    “ID” column accepts only Numbers

    The input value is not supported for the specified column.

    'Device Network' = 123

    “Device Network” column can not be filtered with the provided filter value “123”

    “Device Network” column can not be filtered with the provided filter value “123”

    The input date and time value does not match the supported format.

    'End Time' = 10pm

    “End Time” column accepts only valid date, Example: 11/03/2017 01:14AM

    “End Time” column accepts only valid date, Example: 11/03/2017 01:14AM

    The input value is not supported for the specified column.

    State = SUCCES

    “State” column can not be filtered with the provided filter value “SUCCES”

    “State” column can not be filtered with the provided filter value “SUCCES”

    The input column name is invalid or is of a column for which filtering is not supported.

    State = SUCCESS

    Column name “State is invalid or Filtering of that column is not supported.

    Modified: 2017-12-17