instancemap export (SAP CC 5.0 Setup Tool)

instancemap export

Definition

To export the startup instance map from the database to a file

Command Usage

Syntax

MS Windows: setup.bat instancemap export <TO_FILE_PATH>

UNIX and Linux: ./setup.sh instancemap export <TO_FILE_PATH>

Command Arguments

Name	Definition
`<TO_FILE_PATH>`	The name and the path of the file that will contain the startup instance map

Detailed Information

The export command allows you to get the definition of the startup instance map. This static instance map is stored in the back-end database system (SAP CC Core Database).

Note

This map is partial: it includes only the declarations of the dispatcher and updater instances that compose your SAP CC Core Server system.

Example

See the Additional Information section in the primary help.

Use

You use this command to:

create a quick report for audit or troubleshooting purpose
prepare the import operation (by changing the content of the exported file in a text editor)

Authorization

To work with this command, you must have the Administrator role in your SAP CC user profile.

Refer to the SAP CC 5.0 Security Guide for more user assistance and information about the necessary authorizations.

In Scope

Management of the instance map of the SAP CC system

delete - To delete the startup instance map from the database
export - To export the startup instance map from the database to a file
import - To import the startup instance map into the database

Additional Information

Example

Dummy Example

This dummy example provides you with an overall view of the instance map. The details do not correspond to a real system.

#InstanceId; HCISecure; HCIHost;    HCIPort; WSSecure; WSHost;     WSPort; ExternalSecure; ExternalHost; ExternalPort; InternalSecure; InternalHost; InternalPort 
updater#1  ; off      ; 127.0.0.1 ; 9000   ; off     ; 127.0.0.1 ; 9080  ;               ;             ;             ;               ;             ;              
updater#2  ; off      ; 127.0.0.1 ; 9001   ; off     ; 127.0.0.1 ; 9081  ;               ;             ;             ;               ;             ;              
dispatcher#1; off     ; 127.0.0.1 ; 9100   ; off     ; 127.0.0.1 ; 9180  ; off           ; 127.0.0.1   ; 2000        ; off           ; 127.0.0.1   ; 2100         
dispatcher#2; off     ; 127.0.0.1 ; 9101   ; off     ; 127.0.0.1 ; 9181  ; off           ; 127.0.0.1   ; 2001        ; off           ; 127.0.0.1   ; 2101

Installation

Consult the user assistance Procedures for Securing an SAP CC System Landscape in the SAP CC 5.0 Installation Guide

Technical Operations

To view a complete and up-to-date map of the running instances in your Core Server system:

open your app Display System Status in SAP CC 5.0 Cockpit
use the list command of SAP CC Admin+

Tip

As of SP 2, you can view the system status and the instance map with the app Display System Status in your SAP CC 5.0 Cockpit user interface.

Overview	Application Highlights	Activities and Tasks
As of SP 2, Display System Status is an app in the SAP CC Cockpit application that enables the SAP CC administrators and operations team to always have a clear view of the system status and availability. You view and inspect the system instances quickly and efficiently. You ensure that the instances are up and running or restarting smoothly after a system and software maintenance. Read more information...	With this app, you can: Display and inspect the availability of all the instances that compose your SAP CC Core Server system. Manage some variants to define custom views that facilitate your administrative tasks. Visualize important information that facilitate your technical operations: software version, partitions distribution and reallocation. Briefly observe the restart of your system after an SAP CC software maintenance: shutdown sequences and startup sequences.	Viewing and Inspecting the System Status Managing the System Maintenance Mode Putting Some Instances into Standby Mode

Overview

Application Highlights

Activities and Tasks

As of SP 2, Display System Status is an app in the SAP CC Cockpit application that enables the SAP CC administrators and operations team to always have a clear view of the system status and availability.

You view and inspect the system instances quickly and efficiently. You ensure that the instances are up and running or restarting smoothly after a system and software maintenance.

File Format (CSV)

The file format is CSV (comma separated values). The character encoding UTF-8.

Consider the following definition:

CSV Definition

This comma-separated values file contains the definition of the startup instance map. Each line is the declaration of an instance in your SAP CC Core Server system. The value separator is the semicolon (;).

The file has a table structured format. The first commented line defines this structure. This comment line is optional.

Each line must contain the following information sequentially:

InstanceId
HCISecure
HCIHost
HCIPort
WSSecure
WSHost
WSPort
ExternalSecure (*)
ExternalHost (*)
ExternalPort (*)
InternalSecure (*)
InternalHost (*)
InternalPort (*)

Where:

InstanceId is the most important identifier of an SAP CC system instance: INSTANCE_ID uniquelly identifies an instance in the Core Server system. For example: dispatcher#1 or updater#1
HCI and WS relate to the HCI and Web Services (WS) technical interfaces of SAP CC
External relates to the Message TCP ultra-speed technical interface
Internal relates to the interinstance communications

and:

System Communication Settings

HTTP Communication Infrastructure (HCI) Web Services (WS) Message TCP (*)

External (Client Applications) Internal (Interinstance Comm.)

HCISecure

HCIHost

HCIPort

WSSecure

WSHost

WSPort

ExternalSecure

ExternalHost

ExternalPort

InternalSecure

InternalHost

InternalPort

(*) Note

In a Core Server system, the updater instances do not handle any communication via the Message TCP technical interface.

Do not define these settings in the map.

Legend

HCISecure, WSSecure, ExternalSecure, and InteralSecure are secure modes for the corresponding communication channels as detailed in the Network and Communication Security section of the SAP CC 5.0 Security Guide.

HCIHost, WSHost, ExternalHost, and InternalHost are the hostnames or IP addresses (IPv4 or IPv6) - when you append an asterisk after the host name (or IP address) without any blank space, the multihoming feature is enable.

HCIPort, WSPort, ExternalPort, and InteralPort are the reserved communication ports

System Communication Settings
HTTP Communication Infrastructure (HCI)	Web Services (WS)	Message TCP (*)
External (Client Applications)	Internal (Interinstance Comm.)
`HCISecure` `HCIHost` `HCIPort`	`WSSecure` `WSHost` `WSPort`	`ExternalSecure` `ExternalHost` `ExternalPort`	`InternalSecure` `InternalHost` `InternalPort`
() Note In a Core Server system, the updater instances do not handle any communication via the Message TCP* technical interface. Do not define these settings in the map. Legend `HCISecure`, `WSSecure`, `ExternalSecure`, and `InteralSecure` are secure modes for the corresponding communication channels as detailed in the Network and Communication Security section of the SAP CC 5.0 Security Guide. `HCIHost`, `WSHost`, `ExternalHost`, and `InternalHost` are the hostnames or IP addresses (IPv4 or IPv6) - when you append an asterisk after the host name (or IP address) without any blank space, the multihoming feature is enable. `HCIPort`, `WSPort`, `ExternalPort`, and `InteralPort` are the reserved communication ports

The available technical interfaces depend on the type of the SAP CC system instance. Refer to the SAP CC 5.0 Installation Guide for more user assistance and information about the possible interfaces and instance types to configure in this instance map.

Consult the SAP Note 2622374 - Enabling multihoming to let SAP CC instances listen to client applications on all Ethernet interfaces.

More...

Features and Concepts: SAP CC 5.0 Application Help

Security: SAP CC 5.0 Security Guide

Database: INSTANCE_MAP database table