Overview on EasyCloud cmShell for SAP


This note shows the current available EasyCloud cmShell Function, available in current Release by February 2014.


Function-Name Description Module
Get-CmClusterNodes Get information about one or more nodes (servers)   in a failover cluster. SAP
Add-CmSapUser Create a new Sap user. SAP
Get-CmSapSM51 Returns a table with the status of the SAP   instances. SAP
Get-CmSapReportSRC Returns the source code of   the specified report. SAP
Set-CmSapTMSRequest Creates a new change request. SAP
Get-CmSapUserAuthorizationData Checks if a user has   authorization issues. SAP
Get-CmSapTMSRequestDoc Returns the current documentation of a transport   request SAP
Get-CmSapTMSObjects Returns all Object of a   specific  transport request SAP
Get-CmSapTMSList The function reads all request data for the   request. SAP
Add-CmSapTMSRequest  Appends the repository objects specified in   IT_OBJECTS into the request IV_REQ_ID. SAP
Get-CmSapTMSRequests Selects all changeable change requests from a   system. SAP
Add-CmSapTMSRequestDoc Edit the documentation of   a request SAP
Import-CmSapTMSRequest Import transport requests into a system. SAP
Release-CmSapTMSOrder Release transport Request OSWIN
Release-CmSapTMSRequest Release transport task or request SAP
Get-CmSapUserDetails Returns detail   informations of a user SAP
Get-CmSapSLDComponents Access a SLD and find a SAP system. Get information   about the installed software components and associated support packages. SAP
Get-CmSAPJobSpoolList Read spool list of a job   that has been run. SAP
Set-CmLicense Enter licensekey to activate the product. For   further information contact http://www.connmove.com Other
Save-CmCluster Saves the whole failover   cluster to a configuration file. OSWIN
Move-CmClusterGroup Moves a clustered service or application from one   node to another in a failover cluster. Moving a resource group is a way of   simulating failover. It is also an appropriate step to take in preparation   for routine maintenance on a node. You can move a single group or all group   of a node. OSWIN
Restore-CmCluster Restores a single node or   the whole failover cluster from a configuration file. By default no   group/application will be restarted/shutdown. OSWIN
Start-CmSAPEvent Raising an event SAP
Set-CmSAPJobStep Creates a jobstep-list   that you can use for Set-CmSAPJob. SAP
Set-CmSAPJobPrintParameters Creates an object with print parameters that you   can use for Set-CmSAPJobStep. SAP
Set-CmSAPJobAuditLevel Use this cmdlet to   determine the global audit level for the XMISESSION log. The audit level   controls which messages are logged with sessions with the CCMS system   administration interfaces. SAP
List-CmSAPJobsWithStatus Determines the status of a list of jobs by reading   AS ABAP information on all jobs. SAP
List-CmOsInstalledUpdates Returns a list of the   installed updates. OSWIN
Get-CmSAPVariants Returns a table with the variants of specified   reports SAP
Get-CmSapTable Reading SAP database   tables SAP
Invoke-CmSE38 Runs an ABAP program. SAP
Get-CmSAPJobVariantInfo For a given ABAP the   variants are read. SAP
Get-CmSAPJobStatus Determines the status of a job by reading AS ABAP   information on the job. SAP
Get-CmSAPJobResources You can use this function   module to determine whether background work processes are available at a   particular time on any server in the AS ABAP system. SAP
Get-CmSAPJobLog Get job log (also called job protocol) for a   particular job. SAP
Get-CmSAPJobIntercepted Retrieves jobs which have   status INTERCEPTED SAP
Get-CmSAPJobChildren Get all children created by a job and return them   in an internal table. SAP
Get-CmOsPendingReboot Checks if the specified   system need to reboot. OSWIN
Cancel-CmSAPJob Abort a running job. SAP
Get-CmSapIDOC Returns data from table   ‘EDIPORT’. SAP
Get-CmSAPHostConnect SAP
Get-CmSapFILE Returns data from table   ‘PATH’. SAP
Get-CmSapALE Returns data from table ‘EDIPOA’. SAP
Get-CmRZ12 Gets a list of RZ12 RFC   Server Groups. SAP
Get-CmCredfileEntries  Returns the   data of stored credentials. Other
Add-CmCredfileCredentials You can use this command   to store your credential into the credfile. The credentials will be   encrypted. Other
Remove-CmCredfileCredentials Removes the credential for the specified id Other
Set-CmSM51 Change the status of the   specified SAP instance. SAP
Set-CmRZ12 Adds a new RFC Server Group assignment. SAP
Remove-CmRZ12 Removes all assignments   from the RFC Server Group that you want to delete or from which you want to   remove an instance. SAP
List-CmSapJobServerGroup Lists the names of the SAP JobServerGroups assigned   to the specified SAP instance. SAP
Get-CmSM59 Gets a list of RFC   Connections. SAP
Get-CmSapSystemType Returns data from table ‘T000’. SAP
Get-CmSapMAIL Returns data from table   ‘SXNODES’. SAP
Get-CmSapInstanceInformations Loads more informations of the specified instance. SAP
Invoke-CmSapGuiScripting Load and run a recorded   SAP GUI script. SAP
Close-CmSapGuiConnect Closes the SAP GUI connection and all sessions. SAP
Get-CmSapGuiConnect Opens a connection to the   given SAP system for scripting. The Connection is opened using the assigned   credentials. As soon as a connection has been established a session is   created. SAP
Set-CmSapJobServerGroup Creates a new job background server group to manage   background job processing on a SAP system. SAP
Remove-CmSapRole The cmdlet deletes the   specified activity group assignment for user SapUserName. SAP
Remove-CmSapProfile This cmdlet deletes all of the profile assignments   of the user SapUserName. SAP
Remove-CmSapJobServerInstance Remove a SAP server   instance assignment to a jobserver group in background processing. SAP
Remove-CmSapJobServerGroup Remove a job background server group with all   assignments. SAP
Get-CmSqlConnect Initializes a new instance   of the CmSqlConnection class and returns    a (closed) connection object to the given SQL Server database. DBSQL
Invoke-CmSqlCommand You can use this Cmdlet to perform catalog   operations (for example, querying the structure of a database or creating   database objects such as tables), or to change the data in a database by   executing UPDATE, INSERT, or DELETE statements. DBSQL
Get-CmSapRole This cmdlet connects to   the SAP System and gets a list of all by the identity management provided   user. SAP
Confirm-CmSapUser The method checks that the user SapUserName exists SAP
Add-CmSapRole This method adds a user   role assignment (ActivityGroup). SAP
Add-CmSapProfile This Cmdlet adds a profile assignments for user   SapUserName in a table called PROFILES. All existing assignments will be   kept. SAP
Add-CmSapJobServerInstance Assign a SAP server   instance to an existing job server group. SAP
Start-CmSAPJob Start a job immediately. SAP
Select-CmSAPJob Select a set of jobs in   the SAP R/3 system that match the selection criteria given. By default the   username  is set to the SAP log on name   and the job name is partly specified using wildcards (*). Further more the date   to start from is set to the current date by default and all job selection   criteria (scheduled, released, ready, active, finished, canceled) except   released are chosen. SAP
Remove-CmSAPJob Delets a not running job. SAP
Set-CmSAPJob Create a new SAP   background job with on Step. SAP
Copy-CmSAPJob With this CmdLet you can copy a job definition   including all definition data, except for the start conditions. The copy has   the status ‘scheduled’. A name can be specified for the target with the   parameter target_jobname. If no name is specified, the target job has the   same name as the source job. SAP
Set-CmSMLGLogonGroup Adds a Logon Group /   Instance name assignment. SAP
Get-CmSMLGLogonGroups Gets a list of SMLG Logon Groups. SAP
Remove-CmSMLGLogonGroup Removes all assignments   from the logon group that you want to delete or from which you want to remove   an instance. Use -LogonGroup “Logon Group Name” or set the first   parameter to “LogonGroupName” to delete the desired log on group . Groups   will be removed by default. To remove an instance you have to use named   parameter: -InstanceName “InstanceName” to remove the assignments   of the instance from all logon groups. SAP
Set-CmSM02 Creates a System Message SAP
TypeOf-CmSAPInstance Checks the type of the SAP   Instance, returning the SAPInstance feature list. SAP
Test-CmSAPInstance Checks the running status of the SAP Instance,   returning the SAPControl color code. SAP
Stop-CmSAPInstance Stops immediately an SAP   Instance by reference, system number or list without any further inquiries. SAP
Start-CmSAPInstance Starts an SAP Instance by reference, system number   or list. SAP
List-CmSAPInstance Returns a list of all   instances of the SAP system. features identifies the instance type (ABAP,   J2EE, GATEWAY, MESSAGESERVER, ENQUE, ICMAN, TREX, IGS, ENQREP), e.g.:   Dual-stack dialog instance: “ABAP|J2EE|GATEWAY|ICMAN”
Test-CmOsUpdates Searches for all the applicable software updates   and list them. Checks whether updates are available, returns True / False.   The optional parameter “mandatory” limits the review to absolutely   necessary updates. If the parameter is not specified checks for updates   without restriction. OSWIN
Search-CmOsUpdates Searches for all the   applicable software updates and list them. OSWIN
Restart-CmOsUpdates Immediately performs system shutdown and restart   without any further confirmation. OSWIN
Measure-CmOsUpdates Gets the number of   applicable software updates. OSWIN
Install-CmOsUpdates Installs all previously downloaded updates   (presupposes the execution of the Get-Command). Returns a list of updates and   their installation status. By the optional parameter “reboot” an   automatic restart after installation can be initiated if necessary. If the   parameter is not specified an automatic restart will be initiated. OSWIN
Set-CmLocalSecurityPolicy Sets user or group rights.   Manipulates rights on local or a remote computer. This function use NTRights   utility (Ntrights.exe). OSWIN
Get-CmCluster Establishes a connection between the Cluster   manager and the PowerShell. DBSQL
Close-CmCluster Closes CmCluster   connection. DBSQL
Close-CmSapConnect Close a SAP Connection explicitly. SAP
Start-CmLocalProcess Starts an application in a   new process on the local host. OSWIN
Measure-CmFreeSpace Calculates the available free spacce on a host   drive. OSWIN
Get-CmXmlValues Returns the values which   could be determined using the specified XPath-expression. OSWIN
Get-CmSapConnect The SAP Connect module establishes a connection   between the SAP instance the PowerShell. SAP
Get-CmPageFilePath Gets the location of the   Windows PageFile. The paging file is a reserved space on disk that backs up   committed physical memory on the computer. OSWIN
Get-CmOsVersion If a computer has multiple operating systems   installed, this class only returns an instance for the currently active   operating system. Version number of the operating system. OSWIN
Get-CmOSLCID Gets the locale ID of the   host.. As defined by Microsoft, a locale is either a language or a language   in combination with a country. OSWIN
Get-CmOsConnect Gets an connection object to the user account on   the remote host, returning an CmOSConnection object.  The connection objects gives you access to   the WMI of the remote computer. OSWIN
Get-CmLicenseInformation Shows details of the   entered license. OSWIN
Get-CmGroups Returns a list of group accounts. OSWIN
Disconnect-CmSAPHost Closes the connection   holded by the web service. SAP
Connect-CmSAPHost The start service offers its Web service interface   on port sapctrl<NR> (HTTP) where “<NR>” corresponds to   the SAP instance number (00.98). If the ports are not defined in   etc/services, the default values 5<NR>13 (HTTP)  are used. The port 50013 will be used by   default if no port number was given. SAP
Compare-CmObject These overloaded operator   method perform the appropriate comparison operation, between obj1 and   obj2.Both obj1 and obj2 can be either a string (obj1s, obj2s) object or a double   (obj1d, obj2d).

Acceptable operators are:

“eq”: equal
“ne”: not equal
“lt” : less than
“le”: less or equal
“ge”: greater or equal
“gt”: greater than

Add-CmGroupUser Adds an existing user account to an existing group   on the local host. The process must have administrative privileges. OSWIN
Measure-CmPageFileSize Gets the size of the   PageFile. The paging file is a reserved space on disk that backs up committed   physical memory on the computer. OSWIN
Measure-CmRAMSize Calculates the available RAM on the host. OSWIN
Remove-CmLocalSecurityPolicy Removes user or group   rights. Manipulates rights on local or a remote computer. This function use   NTRights utility (Ntrights.exe). OSWIN
Set-CmXmlValues Sets the specified value at all nodes which could   be determined using the specified XPath-expression. OSWIN
Start-CmProcess Starts an application in a   new process on a remote host. OSWIN
Test-CmAdminPrivilege Checks if you have Administrator rights on your   computer. OSWIN
Test-CmGroupUser Checks if the user account   is assigned to a group on a local, remote or domain user administration. OSWIN
Test-cmPowerOption Checks whether the power plan is the active plan on   the system. A power plan or scheme consists of a group of power settings and   preference information. Each power plan is identified through a unique GUID   as well as by a friendly name. OSWIN
Test-CmProcess Checks whether the   Microsoft Management Console is running on that host using an CmOsConnect   object. OSWIN