Job URL listings

The following topics provide URL field information for each TrueSight Network Automation job types:

About job URLs

In job URLs, three identifiers (IDs) are referenced:

Job ID: Internally assigned by the software (Read Only). A unique Job ID is assigned to each submitted job.
Change ID: A user can assign a Change ID to a job. The same Change ID can be assigned to multiple jobs. The Job Summary report by Change ID provides a Job Summary report for each job assigned the same Change ID. This allows users to group multiple jobs by Change ID for reporting (for example, a single project). When integrated with BMC Remedy Change Management, the Change ID is the Remedy Change ID assigned to a change ticket.
Task ID: Another identifier the user can assign to a job. When integrated with BMC Remedy Change Management, the Task ID is the Remedy Change Task ID.

Job Summary report URL

This URL launches the Job Summary report based on supplied parameters.

The following example displays the Job Summary report for all Jobs with Change ID equal to CRQ000000000037:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=jobSummaryReport&changeID=CRQ000000000037

Jobs list URL

This URL launches the Jobs list based on supplied parameters.

The following example displays the Jobs list for the Change ID equal to CRQ000000000037:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=jobs&changeID=CRQ000000000037

Jobs details URL

This URL launches the details for a single job.

The following example displays the Jobs details for the Job ID equal to BNA0000010816:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=jobDetails&jobID=BNA0000010816

Deploy to Active Span action URL

This URL launches a job with a Deploy to Active Span action filled in with the supplied parameters. This URL corresponds to the job named Deploy to Active in the UI.

The following example performs a Deploy to Active span action of the SNMP Community Template to all devices in the cisco group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=deploytoactive&spanType=group&spanName=cisco&configuration=template&templateName=SNMPCommunity&annotation=30DayRotation

Deploy to Stored Span action URL

This URL launches a job with a Deploy to Stored Span action filled in with the supplied parameters. This URL corresponds to the job named Deploy to Stored in the UI.

The following example performs a Deploy to Stored span action of the Model_1720_Retail Template to the ATLcisco1720-09 device:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=deploytostored&=device&spanName=ATLcisco1720-09&configuration=template&templateName=Model_1720_Retail&annotation=Provision

Custom Span action URL

This URL launches a job with a Custom Span action filled in with the supplied parameters.

The following example executes a custom span action named GetSerialNumber on a group of devices:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=custom&spanType=group&spanName=cisco&name=Get System Serial Number

Reboot Span action URL

This URL launches a job with a Reboot Span action filled in with the supplied parameters.

The following example reboots a device:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=reboot&spanType=device&spanName=ATLcisco1720-09

Mark As Trusted Span action URL

This URL launches a job with a Mark as Trusted Span action filled in with the supplied parameters.

The following example marks the current Running configuration on a device as trusted:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=markastrusted&spanType=device&spanName=ATLcisco1720-09&running=yes

Telnet and SSH Session Span action URL

This URL launches the Telnet/SSH Session Span action with the supplied parameters filled in.

The following example launches the Telnet/SSH session. Because no deviceName is supplied, the user can select the device name from the Telnet/SSH wizard that is displayed.

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=terminal&changeID=RFC-0909

Commit Span action URL

This URL launches a job with a Commit span action filled in with the supplied parameters.

The following example copies the Running configuration to the Startup configuration for each device in the cisco group. Following the commit action, the current Running and Startup configurations for the cixcogroup are marked as trusted.

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=commit&spanType=group&spanName=cisco&markAsTrusted=yes

Snapshot Span action URL

This URL launches a job with a Snapshot Span action filled in with the supplied parameters. This URL corresponds to the job named Snapshot in the UI.

The following example performs a Snapshot span action for all devices in the cisco group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=snapshot&spanType=group&spanName=cisco

Deploy OS Image Span action URL

This URL launches the Deploy OS Image span action with parameters filled in.

The following example performs a Deploy OS Imagespan action for all devices in the Model_Cisco.1720 device group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=osimagedeploy&spanType=group&spanName=Model_Cisco.1720

Snapshot OS Image Span action URL

This URL launches a job with a Snapshot OS Image span action filled in with the supplied parameters. This request copies the OS image binary of the current device into the OS Image Library of the product. This URL corresponds to the job named Snapshot OS in the UI.

The following example performs a Snapshot OS Image span action for all devices in the Model_Cisco.1720 device group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=osimagesnapshot&spanType=group&spanName=Model_Cisco.1720

FindEndpoint action URL

This URL launches a Job with a FindEndpoint action filled in with the supplied parameters.

The following example shows the FindEndpoint action job for the cisco group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=findendpoint&spanType=realm&spanName=cisco&endpointAddress=cisco-02

QuarantineEndpoint action URL

This URL launches a job with a QuarantineEndpoint action filled in with the supplied parameters.

The following example shows the QuarantineEndpoint action job for the cisco group:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=quarantineendpoint&spanType=realm&spanName=cisco&endpointAddress=cisco-02

UnQuarantineEndpoint action URL

This URL launches a job with UnQuarantineEndpoint action filled in with the supplied parameters.

The following example shows the UnQuarantineEndpoint action:

https://<tsna-server>:<tsna-port>/bca-networks/externalurl/external.do?target=unquarantineendpoint&endpointAddress=cisco-02