Bundle Functions

Owned by Stonebranch (Deactivated)
Last updated: May 31, 2023
2 min read

Overview

The command line syntax for each execution of the CLI command, uagcmd, must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).

Universal Controller supports the following CLI functions for Bundles, which are listed alphabetically on this page.

Syntax, parameters, and examples for each function are provided.

Schedule Bundle Promotion

Description

Schedules the promotion of a Bundle.

Syntax

uagcmd ops-promote-bundle global parameters {bundle-id=ID | bundle-name=name} [promotion-target-id=ID | promotion-target-name=name] {[override-user=user] override-password=password} schedule=option {date=date [time=time]} [create-snapshot=option] [notification-option=notification] [allow-unv-tmplt-changes=option]

Parameters
  • bundle-id=
    Required if bundle_name= is not specified; sys_id of the bundle to be promoted.
  • bundle-name=
    Required if bundle_id= is not specified; Name of the bundle to be promoted.
  • promotion-target-id=
    sys_id of the promotion target; Optional if specified on the bundle and if promotion-target-name= is not specified.
  • promotion-target-name=
    Name of the promotion target; Optional if specified on the bundle and if promotion-target-id= is not specified.
  • override-user=
    Optional; User ID to override the user ID provided from the Promotion Target record.
  • override-password=
    Required if override-user= is specified; Password of the User ID being used to override the user ID provided from the Promotion Target record.
  • schedule=
    Required; Specification (not case sensitive) for whether to schedule the promotion (Yes/Y/true) or promote the Bundle immediately (No/N/false).
  • date=
    Required if schedule=Yes/Y/true; Promotion schedule date in format yyyy-MM-dd.
  • time=
    Optional if schedule=Yes/Y/true; Promotion schedule time in format HH-mm (default is 00:00).
  • create-snapshot=
    Optional if schedule=Yes/Y/true; Specification (Yes/Y/true or No/N/false; not case sensitive) for whether a Bundle snapshot should be taken and stored with the scheduled promotion. Default is No/N/false.
  • notification-option=
    Optional; Operation (if any) that will cause a System Notification to be sent when the promotion is done (not case sensitive): operation_failure (default), operation_success/failure, or operation_success.
  • allow-unv-tmplt-changes=
    Optional; Specification (not case sensitive) for whether to allow (Yes/Y/true) or not allow (No/N/false) the Bundle to contain new or changed Universal Templates.

Example

 
uagcmd ops-promote-bundle -c config.cfg bundle-name=Bundle A schedule=Yes date=2015-06-12 create-snapshot=Yes