Versions Compared

Old Version 12

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Panel
Table of Contents
maxlevel1

...

Property

UI Field Name

Description

Specifications

Required

Anchor
bundleAgentClusters - bun
bundleAgentClusters - bun
bundleAgentClusters

Agent Clusters

Task Items to include

String value of task

N

Anchor
bundleApplications - bun
bundleApplications - bun
bundleApplications

Applications

Applications to include

String value of Applications

N

Anchor
bundleBusinessServices - bun
bundleBusinessServices - bun
bundleBusinessServices

Business Services

Business Services Items to include

String value of Business Services

N

Anchor
bundleCalendars - bun
bundleCalendars - bun
bundleCalendars

Calendars

Calendars Items to include

String value of Calendars

N

Anchor
bundleCredentials - bun
bundleCredentials - bun
bundleCredentials

Credentials

Agent Clusters Items to include

String value of Agent Clusters

N

Anchor
bundleCustomDays - bun
bundleCustomDays - bun
bundleCustomDays

Custom Days

Custom Days Items to include

String value of Custom Days

N

Anchor
bundleDatabaseConnections - bun
bundleDatabaseConnections - bun
bundleDatabaseConnections

Database Connections

Database Connections Items to include

String value of Database Connections

N

Anchor
bundleEmailConnections - bun
bundleEmailConnections - bun
bundleEmailConnections

Email Connections

Email Connections Items to include

String value of Email Connections

N

Anchor
bundleEmailTemplates - bun
bundleEmailTemplates - bun
bundleEmailTemplates

Email Templates

Email Templates Items to include

String value of Email Templates

N

bundleOAuthClients

OAuth Clients

OAuth Client Items to include

String value of OAuth Clients

N

Anchor
bundlePeoplesoftConnections - bun
bundlePeoplesoftConnections - bun
bundlePeoplesoftConnections

PeopleSoft Connections

PeopleSoft Connections Items to include

String value of PeopleSoft Connections

N

Anchor
bundleSapConnections - bun
bundleSapConnections - bun
bundleSapConnections

Sap Connections

Sap Connections Items to include

String value of Sap Connections

N

Anchor
bundleScripts - bun
bundleScripts - bun
bundleScripts

Scripts

Scripts Items to include

String value of Scripts

N

Anchor
bundleSnmpManagers - bun
bundleSnmpManagers - bun
bundleSnmpManagers

SNMP Managers

SNMP Managers Items to include

String value of SNMP Managers

N

Anchor
bundleTasks - bun
bundleTasks - bun
bundleTasks

Tasks

Task Items to include

String value of task

N

Anchor
bundleTriggers - bun
bundleTriggers - bun
bundleTriggers

Triggers

Triggers Items to include

String value of Triggers

N

Anchor
bundleUniversalTemplates - bun
bundleUniversalTemplates - bun
bundleUniversalTemplates

Universal Templates

Universal Templates Items to include

String value of Universal Templates

N

Anchor
bundleVariables - bun
bundleVariables - bun
bundleVariables

Variables

Variables Items to include

String value of Variables

N

Anchor
bundleVirtualResources - bun
bundleVirtualResources - bun
bundleVirtualResources

Virtual Resources

Virtual Resources Items to include

String value of Virtual Resources

N

Anchor
defaultPromotionTarget- bun
defaultPromotionTarget- bun
defaultPromotionTarget

Default Promotion Target

Promotion Target server name

String value of target

N

Anchor
description - bun
description - bun
description

Description

Bundle description

String value of description

N

Anchor
excludeOnExistence - bun
excludeOnExistence - bun
excludeOnExistence

Exclude On Existence

Exclude Items on existence

String value

N

Anchor
exportReleaseLevel - bun
exportReleaseLevel - bun
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - bun
exportTable - bun
exportTable

n/aRecord table information.read onlyN

Anchor
followReferences - bun
followReferences - bun
followReferences

Follow References

Follow references items

Boolean value

N

Anchor
name - bun
name - bun
name

Bundle Name

Bundle name

String value of the bundle name

Y

Anchor
opswiseGroups - bun
opswiseGroups - bun
opswiseGroups

Member Of Business Services

List of Business Services that this task belongs to

String value

N

Anchor
promoteBundleDefinition - bun
promoteBundleDefinition - bun
promoteBundleDefinition

Promote Bundle Definition

Promote Bundle Definition

Boolean value

N

Anchor
promoteByBusinessServices - bun
promoteByBusinessServices - bun
promoteByBusinessServices

Promote Member of Business Service

Promote List of Business Services that this task belongs to

String value

N

Anchor
sysId - bun
sysId - bun
sysId

n/aSystem ID field in the database for this Bundles record.

Persisted only if retainSysIds is set to true.

N

Anchor
visibleTo - bun
visibleTo - bun
visibleTo

Visible To

Visible to user

String value of user name

N
(Required if promoteByBusinessServices
is specified)

...

XML Request

JSON Request


Expand
titleXML Request

<bundle>
    <name>bundle-by-service2</name>
    <businessServices>
        <businessService>bus-1</businessService>
        <businessService>bus-2</businessService>
    </businessServices>
    <typesToInclude>Triggers, Tasks, Calendars, Variables, credentialsCredentials</typesToInclude>
    <businessServicesToInclude>
        <businessService>bus-1</businessService>
        <businessService>bus-2</businessService>
    </businessServicesToInclude>
</bundle>



Expand
titleJSON Request

{
    "name": "bundle-service4",
    "typesToInclude": "Triggers, Tasks, Calendars, Variables, Credentials",
    "businessServices": [
      "bus-1",
      "bus-2"
    ],
    "businessServicesToInclude": [
      "bus-1",
      "bus-2"
    ]
}


...

XML Request

JSON Request


Expand
titleXML Request

<bundle>
    <name>bundle-by-service2</name>
    <businessServices>
        <businessService>bus-1</businessService>
        <businessService>bus-2</businessService>
    </businessServices>
    <typesToInclude>Triggers, Tasks, Calendars, Variables, credentialsCredentials</typesToInclude>
    <updatedOnOrAfter>2020-07-01 00:00:00 -0400</updatedOnOrAfter>
</bundle>



Expand
titleJSON Request

{
    "name": "bundle-service4",
    "typesToInclude": "Triggers, Tasks, Calendars, Variables, Credentials",
    "businessServices": [
      "bus-1",
            "bus-2"
    ],
    "updatedOnOrAfter": "2020-07-01 00:00:00 -0400"
}


...

Property

UI Field Name

Description

Specifications

Required

Anchor
bundlename - bunlist
bundlename - bunlist
bundlename

n/a

Request parameter bundlename.

String value of the bundle name. Wildcards are  are supported.

N

Anchor
businessServices - bunlist
businessServices - bunlist
businessServices

n/a

Request parameter businessServices.

String value of the bundle business service.

N

Anchor
defaultPromotionTarget - bunlist
defaultPromotionTarget - bunlist
defaultPromotionTarget

n/a

Request parameter defaultPromotionTarget.

String value of the promotion target. Wildcards are  are supported.

N


Anchor
List Bundles Example Response
List Bundles Example Response
List Bundles: Example Response

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
itemType - promo
itemType - promo
itemType

n/aItem 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
Y

Anchor
itemIds - promo
itemIds - promo
itemIds

n/aIDs for promotion items.Comma-separated list of promotion item IDs.Y
(unless itemNames
is specified)		itemNames

Anchor
itemNames - promo
itemNames - promo
itemNames

n/aNames for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds
is specified)		itemIds

Anchor
promotionTargetId - promo
promotionTargetId - promo
promotionTargetId

n/aID 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

PasswordUser 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 ExistenceItem 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
N

Anchor
followReferences - promo
followReferences - promo
followReferences

Follow ReferencesDynamically 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 ChangesAllow the promotion to contain new or changed Universal Templates.

Valid values:

  • Yes,Y,true
  • No,N,false (default)
Note
titleNote

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


N

Anchor
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
allowUnvTmpltChanges - SBC
allowUnvTmpltChanges - SBC
allowUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:


  • Yes,Y,true
  • No,N,false


Note
titleNote

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


N


Anchor
createSnapshot - SBC
createSnapshot - SBC
createSnapshot

Create Snapshot

Schedule the Bundle promotion using the current Bundle records.

Valid values:

  • Yes,Y,true
  • No,N,false

N


Anchor
date - SBC
date - SBC
date

Date

Date on which to promote the Bundle.


Y
(if schedule
is Yes,Y,true);
format is
yyyy-MM-dd.


Anchor
id - SBC
id - SBC
id

n/a

32-character sysid of the Bundle to be promoted.


Y
(unless name
is specified)

name

Anchor
name - SBC
name - SBC
name

Bundle Name

Name of the Bundle to be promoted.


Y
(unless id
is specified)

id

Anchor
notificationOption - SBC
notificationOption - SBC
notificationOption

System Notification

System Notification to send on success and/or failure of the promotion.

Valid values (not case sensitive):

  • operation Failure (default)
  • operation success/failure
  • operation success

N


Anchor
overridePassword - SBC
overridePassword - SBC
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
overrideUser - SBC
overrideUser - SBC
overrideUser

User

User name to use instead of the default User name for the promotion target.


Y
(if overridePassword
is specified)


Anchor
promotionTargetId - SBC
promotionTargetId - SBC
promotionTargetId

n/a

ID of the Controller cluster node on which to promote the Bundle.

Default is the Default Promotion Target of the specified Bundle.

N

promotionTargetName

Anchor
promotionTargetName - SBC
promotionTargetName - SBC
promotionTargetName

Promotion Target

Name of the Controller cluster node on which to promote the Bundle.

Default is the Default Promotion Target of the specified Bundle.

N

promotionTargetId

Anchor
schedule - SBC
schedule - SBC
schedule

Schedule

Indication of whether or not to schedule a Bundle promotion.

Valid values

  • Yes,Y,true
  • No,N,false.

Y


Anchor
time - SBC
time - SBC
time

Time

Time on which to promote the Bundle.

Default is 00:00.

N


...

Property

UI Field Name

Description

Specifications

Required

Anchor
agentMappings - PT
agentMappings - PT
agentMappings

n/a

List of agentMapping details associated with the Controller

agentMapping details

N

Anchor
authenticationMethod - PT
authenticationMethod - PT
authenticationMethod

Authentication Method

Authentication method to use on the target cluster node of the universal controller.

Valid Values:

  • As String = Basic, As Value = 1

  • As String = Access Token, As Value = 2

Default is Basic (1).

N

Anchor
description - PT
description - PT
description

Description

Promotion Target description

String value of description

N

Anchor
exportReleaseLevel - PT
exportReleaseLevel - PT
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - PT
exportTable - PT
exportTable

n/aRecord table information.read onlyN

Anchor
name - PT
name - PT
name

Name

Name for this Promotion Target.

String value of the promotion target name

Y

Anchor
opswiseGroups - PT
opswiseGroups - PT
opswiseGroups

Member Of Business Services

List of Business Services that this task belongs to

String value

N

Anchor
password - PT
password - PT
password

Password

Login password on the target cluster node of Universal Controller.

String value of password

N

Anchor
retainSysIds - PT
retainSysIds - PT
retainSysIds

n/a

Specification for whether or not the Create a Promotion Target web service will persist the sysId property.

  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.
Note
titleNote

In XML web services, retainSysIds is specified as an attribute in the <script> element.


Valid values: true/false (default is true).

N

Anchor
sourceAgents - PT
sourceAgents - PT
sourceAgents

Source Agent

List of source agent names.

List of source agent names.

N

Anchor
sysId - PT
sysId - PT
sysId

n/a

System ID field in the database for this Prommotion Target record.

Persisted only if retainSysIds is set to true.

N

Anchor
targetAgent - PT
targetAgent - PT
targetAgent

Target Agent

Target agent name.

String value of the target agent name.

Y

token

Personal Access Token

if authenticationMethod = Access Token; the personal access token to use for authentication.

String value

N

Anchor
type - PT
type - PT
type

Type

Agent type.

String value of agent type.

(For example, Windows)

Y

Anchor
uri - PT
uri - PT
uri

URI

Uniform Resource Identifier (URI) used to locate the Promotion Target cluster node.

String value uri.

Y

Anchor
user - PT
user - PT
user

User

Login ID on the target cluster node of Universal Controller.

String value of user.

N

...

Property

UI Field Name

Description

Specifications

Required

targetname

N/A

Request parameter targetname

String value of the target name.

Wildcards are supported.

N

businessServices

N/A

Request parameter businessServices.

String value of the business service

N

...