Bundles and Promotion Web Services
- 1 Overview
- 2 Bundles
- 3 Bundle Report
- 4 Create a Bundle
- 5 Create a Bundle By Business Services
- 6 Create a Bundle By Date
- 7 Delete a Bundle
- 8 List Bundles
- 9 Modify a Bundle
- 10 Read a Bundle
- 11 Promotion
- 12 Bundleless Promotion
- 13 Cancel a Scheduled Bundle Promotion
- 14 Delete a Scheduled Bundle Promotion
- 15 Promote a Bundle or Schedule a Bundle Promotion
- 16 Create a Promotion Target
- 17 Modify a Promotion Target
- 18 List Promotion Targets
- 19 Delete a Promotion Target
- 20 Delete Promotion Target: URI Parameters
- 21 Read a Promotion Target
- 22 Refresh Target Agents
Overview
Universal Controller supports the following RESTful-based web services for Bundles and Promotion operations, which are listed alphabetically on this page under two categories:
Bundles
Promotion
Formatting specifications for each web service, including details about parameter requirements, are provided.
Bundles
Bundle Report
| Description |
|---|---|
URI | |
HTTP Method | GET |
Description | Retrieve Bundle Report details using specific query parameters. |
Example URI | |
URI Parameters | See Bundle Report: URI Parameters, below. |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Bundle Report: Example Response, below. |
Properties | See Bundle Properties. |
Bundle Report: URI Parameters
Parameter | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
| UUID | ID used within the Controller to identify this Bundle. | String value of the bundle sysId. | Y |
|
| Bundle Name | Name used within the Controller to identify this Bundle. | String value of the bundle name. | Y |
|
Bundle Report: Example Response
XML Response | JSON Response |
|---|---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bundle retainSysIds="true">
<name>bundle-test</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
<description>bundle test</description>
<defaultPromotionTarget>local</defaultPromotionTarget>
<followReferences>true</followReferences>
<excludeOnExistence> Triggers, Tasks, Calendars, Custom Days, Variables, Credentials, Agent Clusters, Virtual Resources, Scripts, Email Templates, Email Connections, Database Connections, SAP Connections, PeopleSoft Connections, SNMP Managers</excludeOnExistence>
<opswiseGroups>
<opswiseGroup>bus-1</opswiseGroup>
<opswiseGroup>bus-2</opswiseGroup>
</opswiseGroups>
<promoteBundleDefinition> true</promoteBundleDefinition>
<promoteByBusinessServices>
<businessService>bus-1</businessService>
<businessService>bus-2</businessService>
</promoteByBusinessServices>
<visibleTo> ops.admin</visibleTo>
<bundleTasks>
<bundleTask>
<name>win-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleTask>
<bundleTask>
<name>abc</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleTask>
</bundleTasks>
<bundleApplications>
<bundleApplication>
<name>App-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleApplication>
</bundleApplications>
<bundleTriggers>
<bundleTrigger>
<name>manual-trigger-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleTrigger>
<bundleTrigger>
<name>time-trigger-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleTrigger>
</bundleTriggers>
<bundleCalendars>
<bundleCalendar>
<name>cal-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleCalendar>
</bundleCalendars>
<bundleCustomDays>
<bundleCustomDay>
<name>custome-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleCustomDay>
</bundleCustomDays>
<bundleVariables>
<bundleVariable>
<name>var1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleVariable>
</bundleVariables>
<bundleBusinessServices>
<bundleBusinessService>
<name>bus-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleBusinessService>
</bundleBusinessServices>
<bundleCredentials>
<bundleCredential>
<name>sap-cred</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleCredential>
</bundleCredentials>
<bundleAgentClusters>
<bundleAgentCluster>
<name>Opswise - Default Windows Cluster</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleAgentCluster>
</bundleAgentClusters>
<bundleVirtualResources>
<bundleVirtualResource>
<name>VR-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleVirtualResource>
</bundleVirtualResources>
<bundleScripts>
<bundleScript>
<name>script-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleScript>
</bundleScripts>
<bundleEmailTemplates>
<bundleEmailTemplate>
<name>email-temp-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleEmailTemplate>
</bundleEmailTemplates>
<bundleEmailConnections>
<bundleEmailConnection>
<name>Email-con-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleEmailConnection>
</bundleEmailConnections>
<bundleDatabaseConnections>
<bundleDatabaseConnection>
<name>DB-conn-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleDatabaseConnection>
</bundleDatabaseConnections>
<bundleSapConnections>
<bundleSapConnection>
<name>SAP-conn-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleSapConnection>
</bundleSapConnections>
<bundlePeoplesoftConnections>
<bundlePeoplesoftConnection>
<name>People-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundlePeoplesoftConnection>
</bundlePeoplesoftConnections>
<bundleSnmpManagers>
<bundleSnmpManager>
<name>snmp-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleSnmpManager>
</bundleSnmpManagers>
<bundleUniversalTemplates>
<bundleUniversalTemplate>
<name>univ-test-1</name>
<sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId>
</bundleUniversalTemplate>
</bundleUniversalTemplates>
</bundle> | {
"retainSysIds": true,
"name": "bundle-1",
"sysId": "b52335345df646e5b597dc26df599344",
"description": "bundle test 1",
"opswiseGroups": [
"bus-1",
"bus-2"
],
"defaultPromotionTarget": "local",
"excludeOnExistence": "Triggers, Tasks, Calendars, Custom Days, Variables, Credentials, Agent Clusters, Virtual Resources, Scripts, Email Templates, Email Connections, Database Connections, SAP Connections, PeopleSoft Connections, SNMP Managers, Applications",
"followReferences": true,
"promoteBundleDefinition": true,
"promoteByBusinessServices": [
"bus-1",
"bus-2"
],
"visibleTo": "ops.admin",
"bundleAgentClusters": [
{
"name": "Opswise - Default Linux/Unix Cluster",
"sysId": "0d7f03026a96451fbc3d7a8eecd641d5"
},
{
"name": "Opswise - Default Windows Cluster",
"sysId": "d3f8282f702544d69500928afbcc00f0"
}
],
"bundleApplications": [
{
"name": "app-1",
"sysId": "e12830a711c849388819230203e601d3"
}
],
"bundleBusinessServices": [
{
"name": "bus-1",
"sysId": "b939eedb63544517accd905cfdd13b22"
}
],
"bundleCalendars": [
{
"name": "cal-1",
"sysId": "655b9c498e574ace886b114f79d5933a"
}
],
"bundleCredentials": [
{
"name": "cred-1",
"sysId": "d04886ac74be43a0aa3faa8042f82cca"
}
],
"bundleCustomDays": [
{
"name": "cust-1",
"sysId": "1b0e9acedb98439a8319ac3cd51c21ba"
}
],
"bundleDatabaseConnections": [
{
"name": "db-con-1",
"sysId": "fc8223ece09f407bb9b5bb865574cb49"
}
],
"bundleEmailConnections": [
{
"name": "email-conn",
"sysId": "bd54eae4221a4f909454f7fa04c75efb"
}
],
"bundleEmailTemplates": [
{
"name": "email-temp-1",
"sysId": "5dce586a419448ee83fa121589d60a75"
}
],
"bundlePeoplesoftConnections": [
{
"name": "ps-con-1",
"sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
}
],
"bundleSapConnections": [
{
"name": "sap-1",
"sysId": "a4b0544fb668404ba10b2826b2e6db81"
}
],
"bundleScripts": [
{
"name": "script-1",
"sysId": "01e90371bed4473d87dad00148512f35"
}
],
"bundleSnmpManagers": [
{
"name": "snmp-1",
"sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
}
],
"bundleTasks": [
{
"name": "win-1",
"sysId": "3b50f8c015d6494288328cfdb35d9ea7"
}
],
"bundleTriggers": [
{
"name": "cron-trig-1",
"sysId": "d2869f93a68547beb8e5b156d4fac99e"
}
],
"bundleUniversalTemplates": [
{
"name": "uni-1",
"sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
}
],
"bundleVariables": [
{
"name": "var1",
"sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
}
],
"bundleVirtualResources": [
{
"name": "VR-1",
"sysId": "deeaf3e516ce485fac5fc2283022d904"
}
]
} |
Create a Bundle
| Description |
|---|---|
URI | |
HTTP Method | POST |
Description | Creates a Bundle. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Bundle: Example Request, below. |
Properties | See Bundle Properties. |
Example Response |
|
Create a Bundle: Example Request
XML Request | JSON Request |
|---|---|
|