2 Commands

This chapter provides syntax and examples of CLI commands.

cd

Use this command to change the current context (location) in the resource hierarchy. (The command prompt always displays the current context.)

Usage:

cd newcontext

Argument Definition

Argument	Definition
`newcontext`	An absolute or relative mvPath that becomes the new working context in the data hierarchy. If context contains spaces, you must enclose it in quotes. context is case-sensitive. All contexts in Application Configuration Console do not share a common root. You can use these root level contexts: /Data - the root context of containers and configuration data. This equates to the My Workspace/Data folder for the user who logged in to the CLI. You cannot access the Public Workspace from the CLI. `/Template`–the root context of templates `/Authpack`–the root context of authentication packs `/Resourcespec`–the root context of resource specifications `/Group`–the root context of groups From a particular root context, you can switch to other root contexts or to relative contexts. In the container context, cd supports mvPath that evaluates to containers. You can use these shortcuts: cd .. - the parent context

newcontext

An absolute or relative mvPath that becomes the new working context in the data hierarchy. If context contains spaces, you must enclose it in quotes. context is case-sensitive.

All contexts in Application Configuration Console do not share a common root. You can use these root level contexts:

/Data - the root context of containers and configuration data. This equates to the My Workspace/Data folder for the user who logged in to the CLI. You cannot access the Public Workspace from the CLI.
/Template–the root context of templates
/Authpack–the root context of authentication packs
/Resourcespec–the root context of resource specifications
/Group–the root context of groups

From a particular root context, you can switch to other root contexts or to relative contexts. In the container context, cd supports mvPath that evaluates to containers.

You can use these shortcuts:

cd .. - the parent context

Note:

Application Configuration Console does not require unique container names; For example, you can have two folders named Folder1 in an environment. The CLI cd command cannot navigate past duplicate container names.

Examples

The following example uses the cd command to switch from the Data folder to the QA environment in the 401K project and then back to the Data folder.

/Data =>> ls
401K
Portal

/Data =>> cd 401K

/Data/401K =>> ls
Dev
QA

/Data/401K =>> cd QA

/Data/401K/QA =>> cd /Data

/Data =>> cd 401K/QA

/Data/401K/QA =>>

create

Use this command to create a new Application Configuration Console object in the current context, or to list the object types that can be created in the current context. You will be prompted for the values required to create the object.

Usage:

create [objectType]

Argument	Definition
`objectType`	The type of object to be created. The type must be valid for the current context. If `objectType` is not specified, the valid object types that can be created in the current context are listed.

After specifying a valid object type, you are prompted for any additional information needed to create the object. The UISpec for the object type determines the additional information needed and the text of the prompts.

Examples

The following example creates a new environment under a project.

/Data/401K =>> ls
Dev
QA
Staging

/Data/401K =>> create

Allowed type for creation:
Asset
Layer
Resource
Folder
Environment
Project
ResourceView

/Data/401K =>> create Environment 
Environment Name: Production

/Data/401K =>> ls
Dev
QA
Staging
Production

This example shows the interactive prompting when you create an asset:

/Data/Bluefish =>> ls
Redfish
Dev
Asset1

"list" successful.
/Data/Bluefish =>> create asset
Asset Name:
==>>  Asset2
Auth Pack:(select an index from the following)
1.  solarisv120
2.  solarisv125

==>> 1
Resource spec:(select an index from the following)
1.  AM_IHS
2.  AM_WebSphere_Plugin
3.  AM_WebSphere

==>> 3
Base path:
==>>  /
/Data/Bluefish =>> ls
Redfish
Dev
Asset1
Asset2

"list" successful.
/Data/Bluefish =>>

delete

Use this command to delete the object of the specified type and name from the current context.

Usage:

delete | del [objectType objectName]

Argument	Definition
`objectType`	The type of object to be deleted. The type must be valid for the current context. If `objectType` is not specified, the valid object types that can be deleted in the current context are listed. You can delete authentication packs and groups if the current context allows it.
`objectName`	The name of the object to be deleted.

Examples

The following example deletes an environment from a project.

/Data/401K =>> lsDevQAStagingProduction

/Data/401K =>> delete environment Production

/Data/401K =>> ls
Dev
QA
Staging

/Data/401K =>>

exit

Use this command to end the CLI session and close the console view.

Usage:

exit

help

Use this command to display a list of available commands, or display the syntax and description of a command.

Usage:

help command

Argument	Definition
`command`	A command for which you want to see syntax and usage instructions.

Examples

The following example shows the help for the cd command.

/Data =>> help cd
  usage: cd [newcontext]

  Changes the CLI's current context.
The "root" level contexts can be
     /Data - the Container root context
     /Template - the Template root context
     /Authpack - the Authpack root context
     /Resourcespec - the Resourcespec root context
     /Group - the Group root context

   From a particular root context, you can switch to other root contexts
   or to relative contexts. In the container context cd supports mvpath that
   evaluates to containers.

  For example:   /Data =>> cd P1/WAS
   /Data/P1/WAS =>> cd ..
   /Data/P1 =>> cd /Authpack
   /Authpack =>> cd /
   /Data =>> cd P1/WAS
   /Data/P1/WAS =>> cd
   /Data =>> cd P1/WAS/config/cells/*/nodes
   /Data/P1/WAS/config/cells/solarisv120Network/nodes =>>

history

Use this command to display a list of commands that have been entered.

Usage:

history

Examples

The following example shows a list of commands previously entered during the session.

/Data =>> list
401K
Portal

/Data =>> cd 401K

/Data/401K =>> ls
Dev
QA
Staging

/Data/401K =>> history
list
cd 401K
ls
history

/Data/401K =>>

list

Use this command to list the children of the specified context.

Usage:

list | ls [context]

Argument	Definition
`context`	An absolute or relative mvPath of the context for which you want to list children. If context starts with / then it is an absolute path from one of the root contexts. All other paths are relative to the current context. If context is not specified, the contents of the current context are listed.

Examples

An absolute or relative mvPath of the context for which you want to list children. If context starts with / then it is an absolute path from one of the root contexts. All other paths are relative to the current context. If context is not specified, the contents of the current context are listed.

/Data =>> list
401K
Portal

/Data =>> cd 401K

/Data/401K =>> ls
Dev
QA
Staging

/Data/401K =>> cd /Groups

/Groups =>> ls
All Users
Administrators
DB Admins
Number of groups = 3

log

Use this command to turn CLI logging on or off. When enabled, all standard CLI output is directed to the mvCli.log file, located in the following folder:

%USERPROFILE%\Application Data\ApplicationConfigurationConsole

Where %USERPROFILE% defaults to C:\Documents and Settings\username.

Logging is off by default.

Usage:

log [flag]

Argument	Definition
`flag`	0 = disable logging 1 = enable logging

provision

Use this command to Writes the assets below the current context out to the external resources, using the authentication packs and resource specifications associated with those assets. It is the equivalent of the Provision command in the Application Configuration Console Client; all assets below the current context will be provisioned, not just assets in the current context.

Usage:

provision | pro ["comment"]

Argument	Definition
`comment`	Text describing the changes made or the reason for the provision operation. Optional but recommended.

Examples

The following example shows all of the assets under the Development environment that includes the layers Web Server and Application Server being provisioned.

/Data/Portal View/Development =>> ls
Web Server
Application Server
"list" successful.
/Data/Portal View/Development =>> provision
com.mvalent.api.container.results.MvOperationSummary@130b993
com.mvalent.api.container.results.MvOperationSummary@1e799e6
com.mvalent.api.container.results.MvOperationSummary@28d853
End of provision.
/Data/Portal View/Development =>>

resync

Use this command to synchronize an asset or a configuration with the external resources by overwriting the Application Configuration Console data with the external files. This is the equivalent of the Update command in the Client and is valid for assets and configurations. You must cd to make an asset or a configuration the current context to run this command.

Usage:

resync

Examples

The following example shows the asset TestApp in the App Server container being updated.

/Data/Lab View/Test =>>/Data/Lab View/Test =>> cd "App Server"/Data/Lab View/Test/App Server =>> lsTestApp"list" successful./Data/Lab View/Test/App Server =>> cd TestApp/Data/Lab View/Test/App Server/TestApp =>> resync com.mvalent.api.container.results.MvOperationSummary@1c5eee0End of resync./Data/Lab View/Test/App Server/TestApp =>>

runscript

Use this command to execute a registered script, either interactively or by reading input from a parameter dictionary.

Usage:

runscript [-id scriptid | -id scriptid -param paramdictionary]

Typing runscript with no parameters displays an indexed list of scripts that can be run in the current context. You can select a script from the list and be prompted for input values.
You can optionally specify a script ID to bypass the indexed list.
You also can specify a script ID and a parameter dictionary to run a script without prompting. The keys to the dictionary have to be the control names and the value the data, for example:
```
 runscript -id SampleScript -param "{'sdi_text1':'val1', 
'sdi_combo1':['mylabel','labelid1'],'sdi_subdialog1':{'sdi_text2':'val2', 
'sdi_combo2':['mylabel','labelid2']}}"
```

One way to construct the param string is to create a PyDictionary object in the console and use its str representation as shown:

=>> param = {}
=>> param["sdi_text1"] = "val1"
=>> param["sdi_combo1"] = ["mylabel","labelid1"]
.
.
.
=>> str(param)

(You'll see a message after each command, but the input is still saved in the string.) Copy the output of the above line and paste it in the runscript command.

Examples

This example shows selecting a script from the indexed list and providing input values.

/Data/401K =>> runscript
List of available scripts:(select an index from the following)1. SampleScript2. AnotherScript

==>> 1

Sample Script

This sample script creates an organizational container.

Choose type of container to create:
1. Project
2. Environment
3. Layer
4. Folder

==>> 2
Name for container:

==>> QA

Succeeded

/Data/401K =>> ls
QA

This example runs the same script and passes in the values in a param dictionary. The CLI command prompt is not shown because this format would most likely be used in a script.

runscript -id SampleScript -param "{'containerType':'environment', 'containerName':'QA'}"

suppresswarning

Use this command to suppress the following unrecognized command warning that is displayed before passing the command to the Python shell:

Not a recognized mValent Integrity command. Passing it to the python shell. If you see a secondary prompt and if you intended to type an mValent command press enter to get the primary prompt else continue typing.

Usage:

suppresswarning

unlock

Use this command to force an unlock of a locked asset or configuration in the current context.

Usage:

unlock [commit | rollback]

Argument	Definition
`commit`	Save changes before unlocking the asset or configuration.
`rollback`	Discard changes before unlocking the asset or configuration. (Default)