...
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
| Y |
|
Anchor |
---|
| itemIds - promo |
---|
| itemIds - promo |
---|
|
itemIds | n/a | IDs for promotion items. | Comma-separated list of promotion item IDs. | Y (unless itemNames is specified) | itemNames |
Anchor |
---|
| itemNames - promo |
---|
| itemNames - promo |
---|
|
itemNames | n/a | Names for promotion items. | Comma-separated list of promotion item names. | Y (unless itemIds is specified) | itemIds |
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) |
|
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
| 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)
| N |
|
Anchor |
---|
| Cancel a Scheduled Bundle Promotion |
---|
| Cancel a Scheduled Bundle Promotion |
---|
|
Cancel a Scheduled Bundle Promotion
...
Examples | XML | JSON |
---|
Example Request | | |
...
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 only | N |
Anchor |
---|
| exportTable - PT |
---|
| exportTable - PT |
---|
|
exportTable | n/a | Record table information. | read only | N |
| 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 |
---|
| 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 |
| 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 |
| Type | Agent type. | String value of agent type. (For example, Windows) | Y |
| URI | Uniform Resource Identifier (URI) used to locate the Promotion Target cluster node. | String value uri. | Y |
| 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 |
---|
| {
"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 |
---|
| {
"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", }
|
|
...