Skip to Content

List CCS servers

A List CCS servers request lists the CCS servers and returns the properties for each server. The session details may also be obtained using the includeSessions query parameter. 

HTTP method and URI

{{status colour="Blue" title="GET"/}}

 /mvcm-api/api/ccs/servers

Related topics

Using

RESTful-API-for-BMC-AMI-Ops-Console-Management

Request parameters

Parameter

Data type

Description

includeSessions

Boolean—true or false

A Boolean indicating that session information should be included in the response. 

Response body parameters

Successful completion returns a JSON object with the following parameters:

Parameter

Data type

Description

servers

Array of CCS server information objects

An array of nested objects containing detailed information about all CCS servers

For more information, see Console-Automation-services-data-models.

Example request

GET /mvcm-api/api/ccs/servers
x-api-session: {session id}

Example response

200 OK
<headers>
content-type: application/json
{
    "servers": [
        {
            "startupMode": "automatic",
            "upstreamHost": " osa-icc1.example.com ",
            "authenticationServerHost": "localhost",
            "controllerType": 2,
            "clientAccessPort": 10000,
            "logfileName": "CCS_1.log",
            "clientAccessPortSslEnabled": true,
            "clientAccessPortSsl": 10001,
            "authenticationMethod": "auth-server",
            "requireClientCerts": false,
            "clientAccessPortEnabled": false,
            "name": "CCS_1",
            "upstreamPort": 1024,
            "objectUri": "/mvcm-api/ccs/servers/CCS_1",
            "authenticationServerPort": 1515,
            "status": "running"
        },
        {
            "startupMode": "automatic",
            "upstreamHost": "osa-icc1.example.com",
            "authenticationServerHost": "localhost",
            "controllerType": 2,
            "clientAccessPort": 10010,
            "logfileName": "CCS_2.log",
            "clientAccessPortSslEnabled": true,
            "clientAccessPortSsl": 10011,
            "authenticationMethod": "auth-server",
            "requireClientCerts": false,
            "clientAccessPortEnabled": false,
            "name": "CCS_2",
            "upstreamPort": 1024,
            "objectUri": "/mvcm-api/ccs/servers/CCS_2",
            "authenticationServerPort": 1515,
            "status": "running"
        }
    ]
}


Example request

GET /mvcm-api/api/ccs/servers?includeSessions=true
x-api-session: {session id}

Example response

200 OK
<headers>
content-type: application/json
{
   "servers": [
       {
           "startupMode": "automatic",
           "upstreamHost": "osa-icc1.example.com",
           "sessions": [
               {
                   "maxClients": 10,
                   "server": "CCS_1",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "ABLE",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "ABLE",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_1",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "BAKR",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "BAKR",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_1",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "CRLY",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "CRLY",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_1",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "DLTA",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "DLTA",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               }
            ],
           "authenticationServerHost": "localhost",
           "controllerType": 2,
           "clientAccessPort": 10000,
           "logfileName": "CCS_1.log",
           "clientAccessPortSslEnabled": true,
           "clientAccessPortSsl": 10001,
           "authenticationMethod": "auth-server",
           "requireClientCerts": false,
           "clientAccessPortEnabled": false,
           "name": "CCS_1",
           "upstreamPort": 1024,
           "objectUri": "/mvcm-api/ccs/servers/CCS_1",
           "authenticationServerPort": 1515,
           "status": "running"
       },
       {
           "startupMode": "automatic",
           "upstreamHost": "clm-aus-006632.bmc.com",
           "sessions": [
               {
                   "maxClients": 10,
                   "server": "CCS_2",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "ECHO",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "ECHO",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_2",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "FXTR",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "FXTR",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_2",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "GRGE",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "GRGE",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               },
               {
                   "maxClients": 10,
                   "server": "CCS_2",
                   "keyboardLockoutIdleTimeout": 30,
                   "vtamRestartAfterAllDisconnect": false,
                   "description": "",
                   "extendedAttributes": true,
                   "enableKeyboardLockoutOverride": false,
                   "luName": "HOTL",
                   "enableTn3270e": 0,
                   "enableKeyboardLockout": false,
                   "name": "HOTL",
                   "upstreamPort": 1024,
                   "model": "3278-2",
                   "upstreamUseSsl": false,
                   "enableTn3270eLoginPrompt": 0,
                   "showOnViewersPage": true,
                   "vtam": false
               }
            ],
           "authenticationServerHost": "localhost",
           "controllerType": 2,
           "clientAccessPort": 10010,
           "logfileName": "CCS_2.log",
           "clientAccessPortSslEnabled": true,
           "clientAccessPortSsl": 10011,
           "authenticationMethod": "auth-server",
           "requireClientCerts": false,
           "clientAccessPortEnabled": false,
           "name": "CCS_2",
           "upstreamPort": 1024,
           "objectUri": "/mvcm-api/ccs/servers/CCS_2",
           "authenticationServerPort": 1515,
           "status": "running"
       }
    ]
}







 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Ops Console Management, BMC AMI Ops Console Automation, and BMC AMI Ops SecureHMC 4.1