Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

Requirements for launching reports and jobs from third-party applications

The following topics in this section contain information about the requirements that must be met for third-party applications to launch BMC Network Automation reports and job URLs.

Understanding the general URL rules

The format of each URL must be as follows:

https://<bna-server>:<bna-port>/bca-networks/externalurl/external.do?target=<tagert option>&<additional options>

Use the following general rules for constructing URLs to launch BMC Network Automation reports and jobs.

  • A target (for example, target=discSummaryReport) must be present in every URL. See About target options for a listing of valid targets. Use the following example URL to access the Device Inventory report:

    https://<bna-server>:<bna-port>/bca-networks/externalurl/external.do?target=deviceInventoryReport&selectedFields=iosEntities&spanType=device&spanName=${name}
  • No spaces are permitted in the URL. If a space is required, use the plus sign (+) character to indicate a space.
  • URL parameters must be separated by an ampersand (&) character.

Once you enter a URL, you are directed to the authentication page. Log on as described on Accessing the interface.

About URL target options

The following table lists the supported target options for URLs used to access report and jobs data.

Target option

Description

discSummaryReport

Discrepancy Summary report

discDetailsReport

Discrepancy Details report

changeSummaryReport

Change Summary report

deviceInventoryReport

Device Inventory report

osImageHistoryReport

OS Image History report

complianceSummaryReport

Compliance Summary report

configCompareReport

Configuration Comparison report

jobSummaryReport

Job Summary report

jobs

Jobs List

deploytoactive

Deploy to Active span action

terminal

Telnet/SSH Session span action

commit

Commit span action

snapshot

Snapshot span action

osimagedeploy

Deploy OS Image span action

osimagesnapshot

Snapshot OS Image span action

events

Event List

jobDetails

Job Details

deploytostored

Deploy to Stored span action

reboot

Reboot Span action

markasTrusted

Mark as Trusted span action

custom

Custom action

deviceDetails

View Device report

configDetails

View Device Configuration

findendpoint

FindEndpoint action

quarantineendpoint

QuarantineEndpoint action

unquarantineendpoint

UnQuarantineEndpoint action

Back to top

About time period type parameters

Some URLs (for example, Change Summary report) support the timePeriodType and timePeriod parameters.

The timePeriodType and timePeriod parameters are specified in the following file:

BCAN_HOME/public/bmc/bca-networks/xml/TimePeriodTypeMap.xml

 
timePeriodType parameters

timePeriodType parameter

Description

after

After the specified date (timePeriod). See Specifying a time period before or after a specified date.

before

Before a specified date (timePeriod). See Specifying a time period before or after a specified date.

sinceTrusted

Because a discrepancy was detected.

last2Hours

Last 2 hours.

last4Hours

Last 4 hours.

last6Hours

Last 6 hours.

last8Hours

Last 8 hours.

last12Hours

Last 12 hours.

last24Hours

Last 24 hours.

last48Hours

Last 48 hours.

last7Days

Last 7 days.

last30Days

Last 30 days.

today

Today.

tomorrow

Tomorrow.

yesterday

Yesterday.

thisWeek

This week.

thisMonth

This month.

this year

This year.

lastWeek

Last week.

last year

Last year.

lastMonth

Last month.

range

Specify a range of dates (timePeriod). See  Specifying a range of dates.

Back to top

timePeriod parameters

timePeriod parameter

Description

MM

Month

DD

Date

YY

Two-digit year

HH

Hour in a 24-hour format

MMMinutes
SSSeconds

Specifying a time period before or after a specified date

When specifying timePeriodType=after or timePeriodType=before, use this format anywhere you specify the date or edit configuration files manually:

timePeriod=Date

Date is formatted as follows, regardless of local settings:

MM/DD/YY HH:MM:SS
MM/DD/YYYY HH:MM
MM/DD/YYYY
YYYYMMDDTHHMMSS
YYYYMMDDTHHMM

Dates in the URLs must be correctly encoded (for example, a blank space is %20, and a + symbol is %2b).

Examples for timePeriodType=after:

Example

Description

06/12/2012

All changes made after midnight on June 12, 2012.

06/12/2012 05:00

All changes made after 5 AM on June 12, 2012.

Examples for timePeriodType=before:

Example

Description

06/12/2012

All changes made before midnight on June 12, 2012.

Back to top

Specifying a range of dates

When specifying timePeriodType=range, specify timePeriod as follows:

timePeriod=Date;Date
timePeriod=Date+Offset
timePeriod=Date-Offset
timePeriod=Date@Offset

Date is formatted as follows:

MM/DD/YYYY HH:MM:SS
MM/DD/YYYY HH:MM
MM/DD/YYYY
YYYYMMDDTHHMMSS
YYYYMMDDTHHMM

Dates in the URLs must be correctly encoded (for example, a blank space is %20, and a + symbol is %2b).

Offset is formatted as:

Value

Description

w

Number of weeks

h

Number of hours

m

Number of minutes

s

Number of seconds

d

Number of days

Examples for timePeriodType=range:

Example

Description

06/12/2012 00:00;06/12/2012 23:59

All changes made on June 12, 2012

06/12/2012+12h

All changes made between midnight and noon on June 12, 2012

06/12/2012 01:00-4h

All changes made between 9pm on June 11 and 1am on June 12, 2012

06/12/2012 12:00@4h

All changes made between 10am and 2pm on June 12, 2012

20120612T0100-4h

All changes made between 9pm on June 11 and 1am on June 12, 2012

Back to top

Was this page helpful? Yes No Submitting... Thank you

Comments