Versions Compared

Old Version 13

changes.mady.by.user Former user

Saved on

compared with

New Version 14

changes.mady.by.user Former user

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

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)

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

...

Examples

XML

JSON

Example Request

Expand
titleXML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTarget exportReleaseLevel="7.2.0.0" exportTable="ops_bundle_target" retainSysIds="true">
    <agentMappings/>        
    <name>test</name>
    <description/>
    <opswiseGroups>
        <opswiseGroup>bus-1</opswiseGroup>
        <opswiseGroup>bus-2</opswiseGroup>
    </opswiseGroups>
    <password>********</password>
    <sysId>ed76d6c78f06402d882e155bfd42b98f</sysId>
    <uri>http://localhost:7070/uc</uri>
    <user>ops.admin</user>
</promotionTarget>
Expand
titleJSON
 {
    "agentMappings": [],
    "description": null,
    "name": "test",
    "opswiseGroups": [
        "bus-1",
        "bus-2"
    ],
    "password": "********",
    "retainSysIds": true,
    "sysId": "ed76d6c78f06402d882e155bfd42b98f",
    "uri": "http://localhost:7070/uc",
    "user": "ops.admin"
}

...

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

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

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

...

Anchor
List Promotion Targets Example Response
List Promotion Targets Example Response
List Promotion Targets: Example Response

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

Examples

XML

JSON

Example Response

Expand
titleXML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTargets>
  <promotionTarget exportReleaseLevel="7.2.0.0" exportTable="ops_bundlepromotion_target" retainSysIds="true">
    <agentMappings>
        <agentMapping>
            <sourceAgents>
                <sourceAgent>SBUS30 - AGNT0005</sourceAgent>
            </sourceAgents>
            <targetAgent>SBUS30 - AGNT0005</targetAgent>
            <type>Windows</type>
        </agentMapping>
    <agentMappings>
    <name>test</name> 
    <description/> 
    <opswiseGroups> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups> 
    <password>********</password> 
    <sysId>ed76d6c78f06402d882e155bfd42b98f</sysId> 
    <uri>http://localhost:7070/uc</uri> 
    <user>ops.admin</user> 
  </promotionTarget>
  <promotionTarget exportReleaseLevel="7.2.0.0" exportTable="ops_bundlepromotion_target" retainSysIds="true">
    <agentMappings />
    <name>test</name> 
    <description/> 
    <opswiseGroups> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups> 
    <password>********</password> 
    <sysId>ed76d6c78f06402d882e155bfd42b98f</sysId> 
    <uri>http://localhost:7070/uc</uri> 
    <user>ops.admin</user> 
  </promotionTarget>
</promotionTargets>
Expand
titleJSON
 {
    "agentMappings": [
        {
            "sourceAgents": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent": "SBUS30 - AGNT0005",
            "type": "Windows"
        }
    ],
    "description": null, 
    "nameexportReleaseLevel": "test", 7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test", 
    "opswiseGroups": [ 
       "bus-1", 
       "bus-2" 
    ], 
    "password": "********", 
    "retainSysIds": true, 
    "sysId": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri": "http://localhost:7070/uc", 
    "user": "ops.admin" 
},
{
    "agentMappings": [],
    "description": null, 
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test", 
    "opswiseGroups": [ 
       "bus-2" 
    ], 
    "password": "********", 
    "retainSysIds": true, 
    "sysId": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri": "http://localhost:7070/uc", 
    "user": "ops.admin"

...

Anchor
Read a Promotion Target Example Response
Read a Promotion Target Example Response
Read a Promotion Target: Example Response

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

Examples

XML

JSON

Example Request

Expand
titleXML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTarget exportReleaseLevel="7.2.0.0" exportTable="ops_bundlepromotion_target" retainSysIds="true">
    <agentMappings>
        <agentMapping>
            <sourceAgents>
                <sourceAgent>SBUS30 - AGNT0005</sourceAgent>
            </sourceAgents>
            <targetAgent>SBUS30 - AGNT0005</targetAgent>
            <type>Windows</type>
        </agentMapping>
    <agentMappings>
    <name>test</name> 
    <description/> 
    <opswiseGroups> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups> 
    <password>********</password> 
    <sysId>ed76d6c78f06402d882e155bfd42b98f</sysId> 
    <uri>http://localhost:7070/uc</uri> 
    <user>ops.admin</user> 
</promotionTarget>
Expand
titleJSON
 {
    "agentMappings": [
        {
            "sourceAgents": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent": "SBUS30 - AGNT0005",
            "type": "Windows"
        }
    ],
    "description": null, 
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test", 
    "opswiseGroups": [ 
       "bus-1", 
       "bus-2" 
    ], 
    "password": "********", 
    "retainSysIds": true, 
    "sysId": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri": "http://localhost:7070/uc", 
    "user": "ops.admin" 
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_bundle_target",
}

...