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
     
     

    Global Search Overview

    The global search field on the Junos Space Network Management Platform UI helps you to quickly locate objects within Junos Space Platform. When you search for an object by using global search, Junos Space Platform performs a full-text search operation for objects within Junos Space Platform, and displays the matches found.

    The search results are filtered on the basis of your Role-Based Access Control (RBAC) permissions, such as the tasks that a user is allowed to perform and the domains to which a user is assigned. For example, users are shown results only for tasks for which they have the appropriate permissions or results related to domains to which the users are assigned. For more information about RBAC permissions, see the Role-Based Access Control Overview topic (in the Junos Space Network Management Platform Workspaces Feature Guide).

    The search is performed and the results are displayed based on how the Junos Space Platform objects are indexed. Table 1 lists the indexed objects on which you can perform a search operation by using the global search feature.

    Junos Space Platform monitors its database at regular intervals to identify new objects that need to be indexed. The default interval is set to five seconds.

    Note:

    • An administrator can configure the refresh interval from the Administration workspace. For more information about configuring the refresh interval, see the Index auto update interval in seconds parameter in Modifying Junos Space Network Management Platform Settings (in the Junos Space Network Management Platform Workspaces Feature Guide).
    • An administrator can also refresh the search index manually from the Administration workspace by navigating to Administration > Applications > Network Management Platform and selecting Refresh Search Index from the Actions menu.

    Table 1: Searchable Objects

    Object Category

    Indexed Fields (Category) and Description

    Device

    • name—Name of the device.
    • deviceFamily—Device family of the device.
    • platform—Hardware platform.
    • os—Junos OS version of the device.
    • ip—Device management IP address.
    • connectionStatus—Device connection state, which indicates whether the device is up or down.
    • managedStatus—Device management status, such as “In Sync,” “Connecting,” “Sync Failed,” and so on.
    • serialNumber—Serial number of the device.
    • ccState—Candidate configuration state of the device, such as “Created,” “Accepted,” or “Rejected”.
    • vendor—Name of the device vendor.
    • authenticationStatus—Indicateshow the device is connected to Junos Space, such as “Credential Based,” “Key based,” or “Key Conflict.” Credential-based uses username and password for connection; whereas, key-based needs an RSA key for establishing a connection. The UI displays key conflict when the keys on Junos Space and device are not the same.
    • connectionType—Connection type of the device.

    Physical interface

    • name—Name of the physical interface.
    • ip—Assigned IP address of the physical interface.
    • mac—MAC address of the physical interface.
    • operationStatus—Operational status of the physical interface (up or down).
    • adminStatus—Administrative status of the physical interface (up or down).
    • linkLevelType—Link level type of the physical interface.
    • linkType—Link type of the physical interface, such as full-duplex or half-duplex.
    • speed—Link speed on the physical interface.
    • mtu—MTU of the physical interface.
    • description—Description of the physical interface.

    Logical interface

    • name—Name of the logical interface.
    • ip—IP address of the logical interface.
    • encapsulation—Encapsulation on the logical interface, such as VLAN-VPLS.
    • vlanId—Assigned VLAN number of the logical interface.
    • description—Description of the logical interface.

    Device physical inventory

    • name—Name of the module.
    • version—Software release version of the module.
    • modelNumber—Model number of the module.
    • model—Device family of the module.
    • partNumber—Part number of the module.
    • serialNumber—Serial number of the module.
    • status—Status of the module.
    • description—Description of the module

    Software inventory

    • model—Model of this device.
    • routingEngine—Routing engine of the device.
    • name—Name of the installed software package.
    • version—Version number of the installed software package.
    • type—Type of the installed software package. Permitted values are operating-system, internal-package, and extension.
    • major—Major portion of the version number. For example, in version 13.1R1.14, the major portion is 13.
    • minor—Minor portion of the version number. For example, in version 13.1R1.14, the minor portion is 1.
    • revisionNumber—Revision number of the package. For example, in version 13.1R1.14, the revision number is 1.14.
    • description—Description of the installed software package

    Tags

    name—List of tags assigned to an object

    Audit log

    • userName—Name of the user who performed an action that generated this audit log entry. For example, when userA logs in to Junos Space Network Management Platform, an audit log entry is generated to record the login activity. When you search for userA, this audit log entry is displayed as part of the search results.
    • userIpAddr—IP address from which the action was performed.
    • taskName—Action that was performed by the user, such as Login, Logout, and so on.
    • timeStamp—Date and time of action.
    • executionResult—Result of the action, such as Success, Job Scheduled, and so on.
    • description—Description of the action, such as Login Succeeded, Logout Succeeded, and so on.
    • jobId—Job ID of the action that was performed.

      Note: Not all actions trigger a job.

    • recId—Audit log ID.

    Job

    • jobId—Job ID.
    • name—Name of the job.
    • percent—Percentage of job completed at a given instant,such as 30, 100, and so on.
    • state—Indicates whether the job is a success, failure, or in progress.
    • jobType—Type of job.
    • scheduledStartTime—Date and time at which the job is scheduled to start.
    • actualStartTime—Date and time at which the job actually started.
    • endTime—Date and time at which the job was completed.
    • owner—Name of the user who triggered the job.
    • retryGroupId—Job ID of the original job.
    • previousRetry—Job ID of the previous job.
    • parameter—Objects on which a job is performed or is scheduled to be performed.
    • summary—Operations executed for the job.

    Configlets

    • configletsName—Name of the configlet.
    • configletsCategory—Category specified by a user at the time of creation or modification of a configlet.
    • configletsDeviceFamilySeries—Family of the device.
    • configletsLastestVersion—Latest version of the configlet.
    • configletsDescription—Description of the configlet specified by a user at the time of creation or modification of a configlet.
    • configletsExecutionType—Type of execution of the configlet—single or grouped.
    • configletsCreationTime—Time at which the configlet was created.
    • configletsLastUpdatedTime—Time at which the configlet was last updated.
    • configletsLastModifiedBy—Name (login ID) of the user who last modified the configlet.
    • referenceNumber—Reference number of the configlet, which a user has provided during creation or modification of the configlet.

    Configuration View

    • configurationViewName—Name of the configuration view
    • configurationViewTitle—Title of the configuration view
    • configurationViewDeviceFamilySeries—Family of the device.
    • configurationViewDescription—Description of the configuration view specified by a user at the time of creation or modification of a configuration view
    • configurationViewOrder—Order in which the configuration view must be applied
    • configurationViewType—Type of configuration view—Form view, Grid view, XML view, and CLI view
    • configurationViewCreationTime—Time at which the configuration view was created
    • configurationViewLastUpdatedTime—Time at which the configuration view was last updated
    • configurationViewLastModifiedBy—Name (login ID) of the user who last modified the configuration view

    Scripts

    • scriptName—Name of the script file
    • scriptDescriptiveName—Descriptive name of the script that is mentioned within the script
    • scriptType—Type of script—Commit Script, Op Script, and Event Script
    • scriptExecutionType—Type of execution—Device (script with this execution type should be staged on to a device before it can be executed) and Local (script with this execution type can be executed without having to stage it on a device)
    • scriptFormat—Format of the script file (XSL and SLAX)
    • scriptLatestRevision—Latest version number of the script
    • scriptCreationDate—Time at which the script was imported to the Junos Space server
    • scriptDescription—Description of the script
    • scriptLastUpdatedTime—Time at which the script was last updated
    • deviceNameList—Devices with which a script is associated

    Templates

    • name—Name of the device template
    • currentVersion—Current version of the device template
    • description—Description of the device template
    • modifiedBy—Name (login ID) of the user who last modified the device template
    • modifiedTime—Time at which the template was last updated
    • state—Device template deployment readiness (Needs Review, Disabled, or Enabled)
    • deployStat—Deployment status of the template (assigned, created, or deployed)
    • type—Type of device template (configuration template or quick template)
    • deviceFamily—Supported device family of this device template"

    Template Definition

    • name—Name of the template definition.
    • description—Description of the template definition.
    • deviceFamily—Supported device family of the template definition.
    • state—State of the template definition.
    • schemaVersion—Schema version of the template definition.
    • modifiedBy—User who last modified user the template definition.
    • modifiedTime—Time that the template definition was last modified.

    Xpath and Regex

    • xpathRegexName—Name of the regular expression or XPath
    • xpathRegexValue—XPath or regex value. For example: [a-zA-Z0-9], /device/configuration/interfaces/interface/unit, or /device/configuration/interfaces/interface[name="$INTERFACE.get(0)"]/unit/name/text()
    • xpathRegexPropertyType—Property type—Regular Expression, XPath Context, or XPath Search
    • xpathRegexCreationTime—Time at which the XPath or regular expression was created
    • xpathRegexLastUpdatedTime—Time at which the XPath or regular expression was last updated
    • xpathRegexLastModifiedBy—Name (login ID) of the user who last modified the XPath or regular expression

    Images

    • imagesFileName—Filename of the device image. For example, jinstall-ex-4200-12.3R4.6-domestic-signed.tgz
    • imagesVersion—Version of the device image
    • imagesSeries—Series supported by the device image
    • deviceNameList—Devices on which the device image is deployed

    Report Definitions

    • name—Name of the report definition
    • reportDefintionsCreatedBy—Name (login ID) of the user who created the report definition
    • reportDefinitionsCreatedTime—Time at which the report definition was created
    • reportDefinitionsDecription—Description of the report definition

    Generated Reports

    • name—Name of the generated report
    • generatedReportsGeneratedTime—Time at which the report was generated
    • generatedReportsDescription—Description of the generated report
    • generatedReportsDefinitionName—Name of the report definition using which the report was generated
    • generatedReportsGeneratedBy—Name (login ID) of the user who generated the report
    • generatedReportsFormat—Format of the generated report
    • generatedReportsJobId—ID of the job associated with report generation

    Configuration Files

    • name—Name of the configuration file, which is the device serial name with the .conf file extension
    • configFileDeviceName—Name of the device whose configuration file is backed up
    • lastestConfigFileVersion—Latest version number of the backup configuration file
    • configFileCreationDate—Time when the configuration file was created on the Junos Space server. It corresponds to the time at which you back up a device configuration for the first time from the Junos Space server.
    • configFileLastUpdatedDate—Time at which the device configuration was last modified

    User Accounts

    • userName—Login ID of the Junos Space user
    • userFirstName—First name of the Junos Space user
    • userLastName—Last name of the Junos Space user
    • userEmail—E-mail ID of the Junos Space user
    • userType—Type of the user—local, remote, or read only
    • userStatus—Status of the user—enabled or disabled
    • passwordStatus—Status of the password—active or expired
    • lockedOut—Whether the user is locked out or not
    • roleType—Whether the user has access to the UI, API, or both

    Note:

    • If you are searching for entries in Junos Space Platform on the basis of the date or time field, the correct search results are not returned if the comma (,) or the colon (:) characters are part of the search string.

      For example, to search for Nov 10, 2016 6:21:33 AM, enter the following search string: Nov 10 2016 6 21 33 AM. An exact match is returned if found; otherwise, merged results that match any of the parts of the search string are returned. In this example, if an exact match, Nov 10, 2016 6:21:33 AM, is not found, the search results will return all entries that match any of the space-separated parts of the search string, for example, Nov 9, 2016 7:37:21 AM, Jun 10, 2016 6:21:14 PM, and Nov 4, 2015, 2:12:45 PM.

    • Date and time search works only if both the Junos Space server and the user executing the search are in the same time zone.

    The global search operation also supports query expressions. You can search for phrases and multiple terms. The default operator for multiple terms is the OR operator.

    Note:

    When you enter a query expression, be aware of the following:

    • You must add a back slash “\” if you want to use the following special characters in the search text:

      + && || ! ( ) { } [ ] ^ “ ~ * ? : \

    • Field names are case-sensitive. To search within a specific field, the search syntax is:
      <Indexed field or column name>:<search text>

      For example, if you have a few systems running on Junos OS 12.3 Release 4.5, then “os: 12.3R4.5” returns search results, whereas “OS: 12.3R4.5” does not return search results. This is because the field name that is indexed is “os” and not “OS.” Another example to search for information pertaining to the Junos EX Series devices is to enter “deviceFamily:junos-ex” in the Search field.

    • If you want to search for a term that includes a space, enclose the term within double quotation marks.

      For example, to search for all devices that are synchronized (that is, In Sync), enter “In Sync” in the Search field.

    • You must append "*" if you want to search using partial keywords. Otherwise, the search returns 0 (zero) matches or hits.

    Table 2 provides examples of query expressions that you can enter in the Search field.

    Table 2: Query Expressions in the Search Field

    Query Expression

    Matches Objects That Contain

    snmp

    snmp

    snmp ntp

    snmp or ntp

    snmp OR ntp

    snmp or ntp

    snmp AND ntp

    snmp and ntp

    protocol:snmp

    snmp in the protocol field

    protocol:snmp AND NOT subject:snmp

    snmp in the protocol field but not in the subject field

    (snmp OR ntp) AND http

    http and the terms—snmp or ntp

    description:“http server”

    Exact phrase “http server” in the description field

    description: “http server”~5

    http and server within five positions of one another in the description field (that is, http and server need to have no more than 5 words in-between them)

    ge-*

    Terms that begin with “ge-,” such as ge-0/0/1 or ge-0/0/1.4

    s??p

    Terms such as smtp or snmp

    lastmodified:[1/1/2012 TO 12/31/2012]

    Last modified field values between the dates January 1, 2012 and December 31, 2012

    port:(80 8080 8888)

    80, 8080, or 8888 in the port field

    IPAddress:10.1.1.1

    10.1.1.1 or 10.1.1.0/24 in the IPAddress field

     
     

    Modified: 2016-11-16