Skip to content

Latest commit

 

History

History

sag-spm-boot-winrm

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Bootstrapping Platform Manager on remote Windows machines

With this template you can install Platform Manager (SPM) on remote Windows hosts using the native Windows remoting protocol, which eliminates the requirement to have SSH access.

Important! You cannot use this template to bootstrap Platform Manager 10.11 on remote Windows hosts. Use the "sag-spm-boot-ssh" template instead.

Requirements

Supported Software AG releases

  • Command Central 10.3 to 10.7
  • Platform Manager 9.12 to 10.7

System requirements for the target Windows machines

  • Windows 7 or higher
  • PowerShell version 5.0 or higher
  • DotNet 4.5 or higher (used to unzip)
  • The remote connection user account must have Administrator privileges
  • WinRM service must be running
  • The memory used by PowerShell should be at the 2GB or more

Run the following commands from the PowerShell window as Administrator to ensure that the WinRM service is running and the PowerShell memory is set properly:

Enable-PSRemoting -SkipNetworkProfileCheck
Set-Item WSMan:\localhost\Shell\MaxMemoryPerShellMB 2048
Set-Item WSMan:\localhost\Plugin\Microsoft.PowerShell\Quotas\MaxMemoryPerShellMB 2048
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
Restart-Service winrm

System requirements for the Command Central machine

The machine where Command Central is installed should meet the following requirements:

  • Windows 7 of higher
  • PowerShell version 5.0 or higher
  • DotNet 4.5 or higher ( used for unzip )
  • Must have Command Central bootstrap installer for Windows (.zip) saved in the CC_HOME\profiles\CCE\data\installers folder. Verify by running this command:
sagcc list provisioning bootstrap installers platform=w64
  • Note: If both CCE host and target hosts are not joined in a single Windows domain a trust should be established by rinning command as administrator on CCE host:
Set-Item WSMan:\localhost\Client\TrustedHosts -Value '<targetHost1>,<targetHost2>..'

Running as a standalone Composite Template

When importing the composite template to Command Central, you will have to attach the 'push-bootstrap.ps1' script file. Add the template.yaml and push-bootstrap.ps1 files into a single template.zip file and import that file using the Command Central CLI with the following command:

sagcc exec templates composite import -i template.zip

Bootstrap remote Windows machines on host1 and host2 with version 10.2 of Platform Manager into the C:\SoftwareAG2 installation directory on port 8292. The remote connection user account is the sagadmin account, which has administrative privileges on host1 and host2. The list of hosts should be in the form of a YAML list, that is ["host1","host2"]

sagcc exec templates composite apply sag-spm-boot-winrm nodes=["host1","host2"] \
  cc.installer=cc-def-10.2-fix1-w64.zip \
  install.dir=C:\\SoftwareaAG2 \
  spm.port=8292 \
  os.username=sagadmin os.password=**** \
  
  --sync-job --wait 600

If there are special characters in the password base64-encoded credentials in the format user:password could be provided as a parameter using -Base64Credentials. The credentials could be encoded with oneliner as described below For bash(like):

echo -n 'username:password' |  base64

For powershell:

[Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes('username:password'))

In that case the bootstrap should be done:

sagcc exec templates composite apply sag-spm-boot-winrm nodes=["host1","host2"] \
  cc.installer=cc-def-10.2-fix1-w64.zip \
  install.dir=C:\\SoftwareaAG2 \
  spm.port=8292 \
  os.base64credentials=****** \
  
  --sync-job --wait 600

Adding a Windows infrastructure layer to a stack

Create a new stack with version "10.2" and alias "Dev02" and provision the Windows infrastructure layer to host1 and host2:

sagcc create stacks alias=Dev02 release=10.2
sagcc create stacks Dev02 layers alias=WindowsInfra layerType=INFRA-REMOTE-WINDOWS nodes=[host1,host2] \
  cc.installer=cc-def-10.2-fix1-w64.zip \
  install.dir=C:\\SoftwareaAG2 \
  spm.port=8292 \
  os.username=sagadmin os.password=**** \
  skip.runtime.validation=true \
  --sync-job --wait 600

See sag-cc-all-layer-defs for details about the INFRA-REMOTE-WINDOWS layer type definition.

Using the template from the Command Central Stacks user interface

  1. In Command Central, open the Stacks interface.
  2. Add a new stack.
  3. In the new stack, Add layer > New nodes.
  • Select the INFRA-REMOTE-WINDOWS layer definition.
  • Select the Microsoft Windows x86-64 operating system and a corresponding bootstrap installer.
  • Specify the required parameters, such as:
    • os.username - the username of the remote connection account
    • os.password - the password of the remote connection account
    • os.base64credentials - base64 encoded credentials in the format user:password of the remote connection
    • nodes - one or more host names
    • install.dir - the remote installation directory
  • Finish the wizard
  1. Wait until the provisioning job completes. You can monitor the job from the Jobs view.