Command Central Developer Reference : Using the Command Line Interface : Lifecycle Commands : sagcc exec lifecycle
sagcc exec lifecycle
Executes an action against run-time components. You can execute actions to start, stop, pause, and/or resume run-time components.
Syntax
*Command Central syntax:
*To execute an action against a specified component:
sagcc exec lifecycle  action node_alias componentid  [options]
*To execute an action against run-time components that meet specified search criteria:
sagcc exec lifecycle  action [criteria]  [options]
*Platform Manager syntax:
sagcc exec lifecycle  components  componentid action  [options]
       
 options:       
[{--accept | -a} content_type]       
[{--debug | -d}]       
[{--error | -r} file]       
[{--format | -f} {tsv args | text | xml | csv args | json}]       
[{--log | -l} file]       
[{--output | -o} file]       
[{--password | -p} password]       
[{--quiet | -q}]       
[{--server | -s} url]       
[{--username | -u} user_name]
Arguments and Options
Argument or Option
Description
action
Required. Specifies the action you want to take against the run-time component. Supply one of the following actions:
*start - starts the run-time component
*startindebugmode - starts the run-time component in debug mode
*startinsafemode - starts the run-time component in safe mode
*stop - stops the run-time component
*restart - stops, then restarts the run-time component
*pause - pauses the run-time component
*resume - resumes previously paused run-time component
Run-time components might support all or just a subset of the actions. For information about the supported actions for a run-time component, see information in this reference for the product with which the run-time component is associated.
node_alias
Command Central only.
Required when you do not specify search criteria. Specifies the alias name of an installation. You can determine installation alias names using the sagcc list landscape nodes command.
componentid
Required. Specifies the component ID of a run-time component on which to act. You can determine the IDs for run-time components using the sagcc list inventory components command.
Note:  
Command Central only requires the componentid when you do not specify search criteria.
When executing the command against a Platform Manager, specify the componentidbefore the action in the command syntax.
[criteria]
Command Central only.
Optional. Specifies to act only on the run-time components that match the search criteria you specify. For more information, see Specifying Search Criteria for Lifecycle Commands.
[options]
Optional. Refer to the command syntax for a list of the options the command supports. For a description of the options, see Common Options.
Usage Notes
*The command returns job information, that includes information such as the job ID and job status.
*You can execute the sagcc get monitoring runtimestatus command after executing the sagcc exec lifecycle command to determine when the requested action is complete. Use the {--expected-values |-e}, {--check every |-c}, and {--wait |-w} options with the sagcc get monitoring runtimestatus command to specify the results for which to check and how often to check for the results. For more information, see sagcc get monitoring.
Examples When Executing on Command Central
*To start the run-time component on the installation with alias name “sag01” and component ID “OSGI-SPM”:
sagcc exec lifecycle start sag01 OSGI-SPM
Because the {--server | -s}, {--username | -u}, and {--password | -p} options are not specified, the command uses the default server, user name, and password. For more information, see server, username, and password.
*To stop all run-time components that contain “OSGI” in the component display name:
sagcc exec lifecycle stop displayName=*OSGI* --password secret
Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.
Examples When Executing on Platform Manager
*To restart the run-time component with ID “OSGI-SPM” that is installed in the installation managed by the Platform Manager with host name “rubicon2” and port “8092”, using the authorization of the user with user name “Administrator” and password “manage”:
sagcc exec lifecycle components OSGI-SPM restart --server      
http://rubicon2:8092/spm --username Administrator --password manage
*To stop the run-time component with ID “OSGI-IS” that is installed in the installation managed by the Platform Manager with host name “rubicon2” and port “8092”:
sagcc exec lifecycle components OSGI-IS stop      
--server http://rubicon2:8092/spm --password secret
Because the {--username | -u} option is not specified, the command uses the default user name. For more information, see username. The command specifies “secret” for the user’s password.
Copyright © 2013-2016 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback