Page Comparison

Panel

Table of Contents

maxlevel	1

...

Bundle Report: Example Response

XML Response

JSON Response

Expand

title	XML Response

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?

>
<bundle

> 
    <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>

ExpandtitleJSON Response

 
        <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>

Expand

title	JSON Response

Code Block

language	text

  {
    "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"
      }
    ]
  }

Anchor

	Create a Bundle
	Create a Bundle

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	itemType - promo
	itemType - promo

itemType

n/a

Item type for promotion item(s).

Valid Values:

One of the following (not case sensitive):

Trigger
Task
Calendar
Custom Day
Variable
Business Service
Credential
Agent Cluster
Virtual Resource
Script
Email Template
Email Connection
Database Connection
SAP Connection
PeopleSoft Connection
SNMP Manager
Application
Universal Template
Report
Widget
Dashboard

Y

Anchor

	itemIds - promo
	itemIds - promo

itemIds

n/a

IDs for promotion items.

Comma-separated list of promotion item IDs.

Y
(unless itemNames or items is specified)

itemNames

items

Anchor

	itemNames - promo
	itemNames - promo

itemNames

n/a

Names for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds or items is specified)

itemIds

items

n/a

List of promotion items.

XML:

Code Block

language	text

    <items>
        <item>
            <name>reportTitle1</name>
        </item>  
         <item>
            <name>reportTitle2</name>
            <user>userName</user>
        </item>
        <item>
            <name>reportTitle3</name>
            <group>groupName</group>
        </item>                  
    </items>

JSON:

Code Block

language	text

  "items": [
        {
            "name": "reportTitle1"
        },  
        {
            "name": "reportTitle1",
            "user": "username",
            "group": ""
        },
        {
            "name": "reportTitle2",
            "user": null,
            "group": "group2"
        }
    ]

Y

(unless itemIds
or itemNames is specified)

itemIds

itemNames

Anchor

	promotionTargetId - promo
	promotionTargetId - promo

promotionTargetId

n/a

ID of the Promotion Target.

Y
(unless promotionTargetName
is specified)

promotionTargetName

Anchor

	promotionTargetName - promo
	promotionTargetName - promo

promotionTargetName

Promotion Target

Name of the Promotion Target.

Y
(unless promotionTargetId
is specified)

promotionTargetId

Anchor

	overrideUser - promo
	overrideUser - promo

overrideUser

User

User name to use instead of the default User name for the Promotion Target.

Y
(if overridePassword
is specified)

Anchor

	overridePassword - promo
	overridePassword - promo

overridePassword

Password

User password to use instead of the default User password for the Promotion Target.

Y
(if overrideUser
is specified)

overrideToken

Personal Access Token

Personal Access Token to use instead of the default personal access token for the Promotion Target.

If both overrideToken and overrideUser+overridePassword are specified, overrideToken takes precedence and overrideUser+overidePassword will be ignored.

N

Anchor

	excluseOnExistence - promo
	excluseOnExistence - promo

excludeOnExistence

Exclude On Existence

Item types that will not be updated if they exist on the target server.

Comma-separated list of excluded types.

Valid Values:

As String = Triggers, As Value = 1
As String = Tasks, As Value = 2
As String = Calendars, As Value = 4
As String = Custom Days, As Value = 8
As String = Variables As Value = 16
As String = Credentials, As Value = 64
As String = Agent Clusters, As Value = 128
As String = Virtual Resources, As Value = 256
As String = Scripts, As Value = 512
As String = Email Templates, As Value = 1024
As String = Email Connections As Value = 2048
As String = Database Connections, As Value = 4096
As String = SAP Connections, As Value = 8192
As String = SNMP Managers, As Value = 16384
As String = Applications, As Value = 32768
As String = PeopleSoft Connections, As Value = 65536
As String = Reports, As Value = 262144
As String = Widgets, As Value = 524288

N

Anchor

	followReferences - promo
	followReferences - promo

followReferences

Follow References

Dynamically include items in the promotion that are referenced by promotion items.

Valid values:

Yes,Y,true
No,N,false (default)

N

Anchor

	allUnvTmpltChanges - promo
	allUnvTmpltChanges - promo

allUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

Yes,Y,true
No,N,false (default)

Note

title	Note

In order to promote Universal Template changes, the user must have the ops_universal_template_admin role or the ops_adminrole.

N

Anchor

	Items Properties
	Items Properties

...

Versions Compared

Old Version 8

New Version Current

Key

Bundle Report: Example Response