// removed jquery ui css and js

View Services

Details

API Details
Name

View Services

DescriptionDisplays information for all configured services or for a specified service. Both out-of-box CloudCenter Services and custom services are included in this API.
MethodGET
URI
  • v1/tenants/tenantId/services
  • v1/tenants/tenantId/services/serviceId
  • v1/tenants/tenantId/services?parentService=true
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the defaultImageId and serviceActions attributes.
  • Enhanced in CloudCenter 4.3 to include the externalBundleLocation attribute and to deprecate the bundleRequired attribute
  • Enhanced in CloudCenter 4.9.0 to include:
    • The CONTAINER enumeration in the serviceType attribute.
    • The CONTAINER_POST_START and CONTAINER_PRE_STOP in the actionName attribute.
    • The secret type in serviceParamSpecs attribute.
    • Additional container-specific attributes.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Header
  • action: get.tenants.tenantId.service
  • action: get.tenants.tenantId.service.serviceId
  • action: get.tenants.tenantId.service
    actionparam: parentService=true

Example 1 – v1/tenants/tenantId/services

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/services"  

Response

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/services",
    "size": 20,
    "pageNumber": 0,
    "totalElements": 20,
    "totalPages": 1,
    "services": [
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/services/2",
            "perms": [
                "write",
                "delete",
                "read",
                "administration"
            ],
            "name": "hadoop",
            "displayName": "Hadoop",
            "description": "Scalable, distributed computing",
            "logoPath": "/assets/img/tiers/hadoop.png",
            "defaultImageId": "2",
            "parentServiceId": null,
            "parentService": false,
            "systemService": true,
            "externalService": false,
            "visible": true,
            "externalBundleLocation": null,
            "bundleLocation": null,
            "costPerHour": 0,
            "ownerUserId": "2",
            "serviceActions": [
                {
                    "actionName": "START",
                    "actionType": "SCRIPT",
                    "actionValue": "service start"
                },
                {
                    "actionName": "STOP",
                    "actionType": "SCRIPT",
                    "actionValue": "service stop"
                }
            ],
            "servicePorts": [
                {
                    "id": "10",
                    "resource": null,
                    "perms": [],
                    "protocol": "TCP",
                    "fromPort": "1",
                    "toPort": "65535"
                }
            ],
            "serviceParamSpecs": [],
            "egressRestrictions": [],
            "childServices": [],
            "images": [],
            "repositories": []
        },
        ...
        {
            "id": "34",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/services/34",
            "perms": [
                "write",
                "delete",
                "read",
                "administration"
            ],
            "name": "jetty",
            "displayName": "Jetty",
            "description": "Java-based HTTP server",
            "logoPath": "/assets/img/tiers/jetty.png",
            "defaultImageId" : 2
            "parentServiceId": "37",
            "parentService": false,
            "systemService": true,
            "externalService": false,
            "visible": true,
            "externalBundleLocation": null,
            "bundleLocation": null,
            "costPerHour": 0,
            "ownerUserId": "2",
            "serviceActions": [
                {
                    "actionName": "CONFIGURE",
                    "actionType": "SCRIPT",
                    "actionValue": "service configure"
                },
                {
                    "actionName": "DEPLOY",
                    "actionType": "SCRIPT",
                    "actionValue": "service deploy"
                },
                {
                    "actionName": "RESTART",
                    "actionType": "SCRIPT",
                    "actionValue": "service restart"
                },
                {
                    "actionName": "UPGRADE",
                    "actionType": "SCRIPT",
                    "actionValue": "service upgrade"
                },
                {
                    "actionName": "STOP",
                    "actionType": "SCRIPT",
                    "actionValue": "service stop"
                },
                {
                    "actionName": "RELOAD",
                    "actionType": "SCRIPT",
                    "actionValue": "service reload"
                },
                {
                    "actionName": "INSTALL",
                    "actionType": "SCRIPT",
                    "actionValue": "service install"
                },
                {
                    "actionName": "CLEANUP",
                    "actionType": "SCRIPT",
                    "actionValue": "service cleanup"
                },
                {
                    "actionName": "START",
                    "actionType": "SCRIPT",
                    "actionValue": "service start"
                }
            ],
            "servicePorts": [
                {
                    "id": "15",
                    "resource": null,
                    "perms": [],
                    "protocol": "TCP",
                    "fromPort": "80",
                    "toPort": "80"
                },
                {
                    "id": "16",
                    "resource": null,
                    "perms": [],
                    "protocol": "TCP",
                    "fromPort": "443",
                    "toPort": "443"
                }
            ],
            "serviceParamSpecs": [
                {
                    "paramName": "cliqrJDKVersion",
                    "displayName": "App Run-time",
                    "helpText": null,
                    "type": "list",
                    "valueList": "JDK 6:JDK6,JDK 7:JDK7",
                    "defaultValue": "JDK6",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "regex": null,
                        "allowSpaces": true,
                        "maxLength": 0,
                        "sizeValue": 0,
                        "step": 0
                    },
                    "collectionList": []
                },
                {
                    "paramName": "cliqrWebappConfigFiles",
                    "displayName": "App Config files",
                    "helpText": "Application config files that contain system
 tokens and will be modified at deployment time. The config file is a relative path
 from the webapp context folder, e.g., WEB-INF/classes/db.conf. If there are 
 multiple files, separate with semicolon.",
                    "type": "string",
                    "valueList": null,
                    "defaultValue": "",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": true,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "regex": null,
                        "allowSpaces": true,
                        "maxLength": 255,
                        "sizeValue": 0,
                        "step": 0
                    },
                    "collectionList": []
                },
                {
                    "paramName": "cliqrWARFile",
                    "displayName": "App Package",
                    "helpText": "Application package file. Relative path from %rootPath%.",
                    "type": "path",
                    "valueList": null,
                    "defaultValue": "",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": true,
                    "exampleValue": "myapp/myapp.war",
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "regex": null,
                        "allowSpaces": false,
                        "maxLength": 0,
                        "sizeValue": 0,
                        "step": 0
                    },
                    "collectionList": []
                },
                {
                    "paramName": "cliqrWebappContext",
                    "displayName": "Deploy Context",
                    "helpText": null,
                    "type": "string",
                    "valueList": null,
                    "defaultValue": "ROOT",
                    "userVisible": true,
                    "userEditable": true,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": {
                        "minValue": 0,
                        "maxValue": 0,
                        "regex": null,
                        "allowSpaces": false,
                        "maxLength": 255,
                        "sizeValue": 0,
                        "step": 0
                    },
                    "collectionList": []
                },
                {
                    "paramName": "cliqrEARPath",
                    "displayName": "EAR file",
                    "helpText": null,
                    "type": null,
                    "valueList": null,
                    "defaultValue": "",
                    "userVisible": false,
                    "userEditable": false,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": null,
                    "collectionList": []
                },
                {
                    "paramName": "cliqrPlanPath",
                    "displayName": "Plan file",
                    "helpText": null,
                    "type": null,
                    "valueList": null,
                    "defaultValue": "",
                    "userVisible": false,
                    "userEditable": false,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": null,
                    "collectionList": []
                },
                {
                    "paramName": "appMigrationFiles",
                    "displayName": "Application Migration Files",
                    "helpText": null,
                    "type": null,
                    "valueList": null,
                    "defaultValue": "cliqrWARFile,cliqrEARPath,cliqrPlanPath",
                    "userVisible": false,
                    "userEditable": false,
                    "systemParam": true,
                    "exampleValue": null,
                    "dataUnit": null,
                    "optional": false,
                    "valueConstraint": null,
                    "collectionList": []
                }
            ],
            "egressRestrictions": [],
            "childServices": [],
            "images": [
                {
                    "id": "2",
                    "resource": null,
                    "perms": [],
                    "name": "Ubuntu 12.04",
                    "internalImageName": "CloudWorker-Ubuntu12.04",
                    "description": "Ubuntu 12.04",
                    "visibility": "PUBLIC",
                    "imageType": "CLOUD_WORKER",
                    "osName": "LINUX",
                    "tags": [],
                    "numOfNics": 1,
                    "tenantId": 1,
                    "enabled": true,
                    "systemImage": true,
                    "detail": null,
                    "count": 3
                }
            ],
            "repositories": []
        }
    ]
}

Example 2 – v1/tenants/tenantId/services/serviceId

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/tenantId/13"  

Response

{
    "id": "13",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/services/13",
    "perms": [
        "write",
        "delete",
        "read",
        "administration"
    ],
    "name": "tomcat7",
    "displayName": "Tomcat7",
    "description": "Implementation of the Java Servlet v7",
    "logoPath": "/assets/img/tiers/tomcat7.png",
    "defaultImageId": "2",
    "parentServiceId": "37",
    "parentService": false,
    "systemService": true,
    "externalService": false,
    "visible": true,
    "externalBundleLocation": null,
    "bundleLocation": null,
    "costPerHour": 0,
    "ownerUserId": "2",
    "serviceActions": [
        {
            "actionName": "RESTART",
            "actionType": "SCRIPT",
            "actionValue": "service restart"
        },
        {
            "actionName": "STOP",
            "actionType": "SCRIPT",
            "actionValue": "service stop"
        },
        {
            "actionName": "RELOAD",
            "actionType": "SCRIPT",
            "actionValue": "service reload"
        },
        {
            "actionName": "DEPLOY",
            "actionType": "SCRIPT",
            "actionValue": "service deploy"
        },
        {
            "actionName": "CLEANUP",
            "actionType": "SCRIPT",
            "actionValue": "service cleanup"
        },
        {
            "actionName": "START",
            "actionType": "SCRIPT",
            "actionValue": "service start"
        },
        {
            "actionName": "CONFIGURE",
            "actionType": "SCRIPT",
            "actionValue": "service configure"
        },
        {
            "actionName": "INSTALL",
            "actionType": "SCRIPT",
            "actionValue": "service install"
        },
        {
            "actionName": "UPGRADE",
            "actionType": "SCRIPT",
            "actionValue": "service upgrade"
        }
    ],
    "servicePorts": [
        {
            "id": "32",
            "resource": null,
            "perms": [],
            "protocol": "TCP",
            "fromPort": "80",
            "toPort": "80"
        },
        {
            "id": "33",
            "resource": null,
            "perms": [],
            "protocol": "TCP",
            "fromPort": "443",
            "toPort": "443"
        }
    ],
    "serviceParamSpecs": [
        {
            "paramName": "cliqrJDKVersion",
            "displayName": "App Run-time",
            "helpText": null,
            "type": "list",
            "valueList": "JDK 6:JDK6,JDK 7:JDK7",
            "defaultValue": "JDK6",
            "userVisible": true,
            "userEditable": true,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": false,
            "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "regex": null,
                "allowSpaces": true,
                "maxLength": 0,
                "sizeValue": 0,
                "step": 0
            },
            "collectionList": []
        },
        {
            "paramName": "cliqrWebappConfigFiles",
            "displayName": "App Config files",
            "helpText": "Application config files that contain system tokens 
and will be modified at deployment time. The config file is a relative path from 
the webapp context folder, e.g.,  WEB-INF/classes/db.conf. If there are multiple 
files, separate with  semicolon.",
            "type": "string",
            "valueList": null,
            "defaultValue": "",
            "userVisible": true,
            "userEditable": true,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": true,
            "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "regex": null,
                "allowSpaces": true,
                "maxLength": 255,
                "sizeValue": 0,
                "step": 0
            },
            "collectionList": []
        },
        {
            "paramName": "cliqrWARFile",
            "displayName": "App Package",
            "helpText": "Application package file. The file is in relative path 
from %rootPath%.",
            "type": "path",
            "valueList": null,
            "defaultValue": "",
            "userVisible": true,
            "userEditable": true,
            "systemParam": true,
            "exampleValue": "myapp/myapp.war",
            "dataUnit": null,
            "optional": false,
            "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "regex": null,
                "allowSpaces": false,
                "maxLength": 0,
                "sizeValue": 0,
                "step": 0
            },
            "collectionList": []
        },
        {
            "paramName": "cliqrWebappContext",
            "displayName": "Deploy Context",
            "helpText": null,
            "type": "string",
            "valueList": null,
            "defaultValue": "ROOT",
            "userVisible": true,
            "userEditable": true,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": false,
            "valueConstraint": {
                "minValue": 0,
                "maxValue": 0,
                "regex": null,
                "allowSpaces": false,
                "maxLength": 255,
                "sizeValue": 0,
                "step": 0
            },
            "collectionList": []
        },
        {
            "paramName": "cliqrEARPath",
            "displayName": "EAR file",
            "helpText": null,
            "type": null,
            "valueList": null,
            "defaultValue": "",
            "userVisible": false,
            "userEditable": false,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": false,
            "valueConstraint": null,
            "collectionList": []
        },
        {
            "paramName": "cliqrPlanPath",
            "displayName": "Plan file",
            "helpText": null,
            "type": null,
            "valueList": null,
            "defaultValue": "",
            "userVisible": false,
            "userEditable": false,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": false,
            "valueConstraint": null,
            "collectionList": []
        },
        {
            "paramName": "appMigrationFiles",
            "displayName": "Application Migration Files",
            "helpText": null,
            "type": null,
            "valueList": null,
            "defaultValue": "cliqrWARFile,cliqrEARPath,cliqrPlanPath",
            "userVisible": false,
            "userEditable": false,
            "systemParam": true,
            "exampleValue": null,
            "dataUnit": null,
            "optional": false,
            "valueConstraint": null,
            "collectionList": []
        }
    ],
    "egressRestrictions": [],
    "childServices": [],
    "images": [
        {
            "id": "2",
            "resource": null,
            "perms": [],
            "name": "Ubuntu 12.04",
            "internalImageName": "CloudWorker-Ubuntu12.04",
            "description": "Ubuntu 12.04",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": true,
            "detail": null,
            "count": 3
        }
    ],
    "repositories": []
}

Example 3 – Container Service

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/tenantId/217"  

Response

{
   "id":"217",
   "resource":"http://ccm/v1/tenants/1/services/217",
   "perms":[
      "administration",
      "read",
      "delete",
      "write"
   ],
   "name":"myservice35",
   "displayName":"aba35",
   "description":"",
   "logoPath":"/custom/assets/vendors/1/img/DefaultApp.png",
   "parentServiceId":"48",
   "parentService":false,
   "systemService":false,
   "externalService":false,
   "visible":true,
   "bundleLocation":"",
   "isBundleRequired":false,
   "externalBundleLocation":"",
   "isExternalBundleRequired":false,
   "costPerHour":1,
   "costPerHourPreferredCurrency":0,
   "defaultImageId":0,
   "serviceType":"CONTAINER",
   "ownerUserId":"2",
   "serviceActions":[
      {
         "actionName":"CONTAINER_PRE_STOP",
         "actionType":"CMD",
         "actionValue":"ls -ltr"
      },
      {
         "actionName":"CONTAINER_POST_START",
         "actionType":"URL",
         "actionValue":"jioj"
      }
   ],
   "externalActions":[

   ],
   "servicePorts":[

   ],
   "serviceParamSpecs":[
      {
         "paramName":"myservice2",
         "displayName":"myservice2",
         "helpText":"",
         "type":"secret",
         "valueList":null,
         "defaultValue":"",
         "confirmValue":null,
         "pathSuffixValue":"",
         "userVisible":false,
         "userEditable":false,
         "systemParam":false,
         "exampleValue":null,
         "dataUnit":null,
         "optional":false,
         "deploymentParam":true,
         "multiselectSupported":false,
         "valueConstraint":{
            "minValue":0,
            "maxValue":0,
            "maxLength":0,
            "regex":null,
            "allowSpaces":true,
            "sizeValue":0,
            "step":0,
            "calloutWorkflowName":null
         },
         "scope":null,
         "webserviceListParams":null,
         "secret":{
            "name":"code",
            "value":"key"
         },
         "collectionList":[

         ]
      },
      {
         "paramName":"testing2",
         "displayName":"sadfe2",
         "helpText":"",
         "type":"password",
         "valueList":null,
         "defaultValue":"kLfu99jS1NkuoB7tuocBe5bE8vKI7wy1F/99zksNxVM=",
         "confirmValue":null,
         "pathSuffixValue":"",
         "userVisible":false,
         "userEditable":false,
         "systemParam":false,
         "exampleValue":null,
         "dataUnit":null,
         "optional":false,
         "deploymentParam":true,
         "multiselectSupported":false,
         "valueConstraint":{
            "minValue":0,
            "maxValue":0,
            "maxLength":0,
            "regex":null,
            "allowSpaces":true,
            "sizeValue":0,
            "step":0,
            "calloutWorkflowName":null
         },
         "scope":null,
         "webserviceListParams":null,
         "secret":null,
         "collectionList":[

         ]
      }
   ],
   "egressRestrictions":[

   ],
   "childServices":[

   ],
   "images":[

   ],
   "repositories":[

   ],
   "containerImages":[
      {
         "id":238,
         "url":"webpress",
         "default":false
      },
      {
         "id":239,
         "url":"jenkins",
         "default":true
      }
   ],
   "containerPorts":[
      {
         "id":235,
         "protocol":"UDP",
         "name":"aaaaaaaaaaaaaaa",
         "port":212
      },
      {
         "id":236,
         "protocol":"TCP",
         "name":"portname2",
         "port":213
      }
   ]
}


Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String

serviceId
  • DescriptionUnique, system-generated identifier for a service. This ID only uses and accepts alphanumeric characters.
  • Type: String

See the response attributes

Response Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String


name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String


displayName
  • DescriptionA descriptive name for this CloudCenter resource.
  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

logoPath
  • Type: String


parentServiceId
  • Description: Unique, system-generated identifier for a service category (a service inherits some attributes from its service category when the service is used to model application profiles)
  • Type: String

parentService
  • Description: The service category or a group determined by the admin when defining a service. For example, MySql and Oracle services both have the Database category (or group) as its parent. See Topology Modeler Services or Manage Services for additional context. 
    • true = This is the parent service ( value should always be true for consumers using only REST APIs)
    • false = This is not the parent service
  • Type: Boolean

systemService

externalService
  • Description: Identifies if this service is an external Service:
    • true = This is the external service
    • false = This is not the external service
  • Type: Boolean

visible
  • Description: Identifies if this parameter should be visible to the users within a tenant
    • true = The service is displayed if the request attribute parentService = true
    • false = The service is displayed if the request attribute parentService = false
  • Type: Boolean


bundleLocation
  • Description: Location of the zip file that contains the Bundle Store artifacts that are downloaded during deployment orchestration.

    • Its value is a HTTP(S) URL.

    • The contents of this ZIP file is used to locate the Service Lifecycle Actions definition if it is a SCRIPT.

    • See Manage Services and Parameters and Macros for additional context.

  • Type: String

isBundleRequired
  • Description: Identifies if the HTTP(S) URL of the zip file that contains the Bundle Store artifacts that are downloaded during deployment orchestration is required.

  • Type: Boolean

    • true = The Bundle Store location is required.

    • false = Default. The Bundle Store location is not required.

 externalBundleLocation
  • Description: Location of the zip file that contains the external Bundle Store artifacts that are downloaded during deployment orchestration. 
    • The External Actions Bundle zip file contains all scripts required to manage the external lifecycle. You must provide the following information for this zip file depending on the resource being configured:

      • If you are configuring this file at the cloud region level – this file must contain a directory called cloudregion which contains all the scripts.

      • If you are configuring this file for a service – name this file as ServiceID.zip. For example, tomcat6.zip, where tomcat6 is the Service ID.

    • This attribute is available for all service types
    • The bundle is validated against associated repositories.
    • The repositories field should not be empty.
    • The Service Lifecycle Actions definition (if it is a SCRIPT) is used to locate the scripts in this ZIP file.
    • See Manage Services and the "Parameters and Macros" sections for the relevant release or additional context.
  • Type: String


isExternalBundleRequired
  • Description: Identifies if the location of the zip file that contains the scripts is required to manage the external lifecycle.

  • Type: Boolean

    • true = The ZIP file location is required.

    • false = Default. The Zip file location is not required.

costPerHour
  • Description:  The dollar price per hour to use this service. Only the user who created this service (service owner) can set this value (once) for all users using this service.
  • Type: Float

defaultImageId
  • DescriptionUnique, system-generated identifier for the default image mapped to a service
  • Type: String

serviceType
  • Description: The types of service buckets provided by the CloudCenter to define a new service. See External Service and Cloud Service for additional context.

  • Type: Enumeration

    EnumerationDescription
    VM_AGENTDefault. Service based on a VM with a Management Agent
     VM_NO_AGENTService based on a VM without a Management Agent
     EXTERNAL External Service
    CONTAINERContainer Service (effective CloudCenter 4.9.0)

 ownerUserId 
  • DescriptionUnique, system-generated identifier for the owner of the resource. For example, a ServiceNow extension owner's User ID.

  • Type: String

serviceActions
  • Description: Defines the actions to be defined for each service for each phase when you create/update the service
  • Type: Array of Service Lifecycle Actions

    actionName
    • Type: Enumeration
    actionType
    • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
    • Type: Enumeration

      EnumerationDescription
      SCRIPT

      Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
      - Linux VMs = /usr/local/osmosix/service/serviceName
      - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

      See the Service Lifecycle Action section for the relevant release for additional context.

       This option is not available for Container Service.

      URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
      CMD

      Indicates the command that is be executed on the VM during actionName step.

      The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

      - Linux VMs = cliqruser

      - WindowsVMs = cliqr

      See the Service Lifecycle Action section for the relevant release for additional context.

      Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

    actionValue
    • Description: Identifies the value that you provide for the selected actionType.

    • Type: String

externalActions
  • Description: Defines the actions to be defined for each service for each phase when you create/update the service
  • Type: Array of service lifecycle actions. See the Service Lifecycle Actions section for the relevant release for additional context.

    actionName
    • Type: Enumeration
    actionType
    • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
    • Type: Enumeration

      EnumerationDescription
      SCRIPT

      Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
      - Linux VMs = /usr/local/osmosix/service/serviceName
      - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

      See the Service Lifecycle Action section for the relevant release for additional context.

       This option is not available for Container Service.

      URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

      The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
      CMD

      Indicates the command that is be executed on the VM during actionName step.

      The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

      - Linux VMs = cliqruser

      - WindowsVMs = cliqr

      See the Service Lifecycle Action section for the relevant release for additional context.

      Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

    actionValue
    • Description: Identifies the value that you provide for the selected actionType.

    • Type: String

servicePorts
  • Description: Defines the TCP/IP transport layer protocol used in this inbound firewall rule (or security rule)
  • Type: Array of firewallRules

    firewallRule
    • Description: Identifies firewall rules based on your application topology to allow inter-communication between nodes
    • Type: Array of mapped attributes

      protocol
      • Description: Defines the protocol to be used by VMs running this service.
      • Type: Enumeration:

        ProtocolDescription
        TCPTransmission Control Protocol
        UDPUser Datagram Protocol
       fromPort 
      • Description: The initial port number of the port range to use for this inbound firewall rule (or security rule)
      • Type: String
      toPort 
      • Description: The final port number of the port range to use for this inbound firewall rule (or security rule)
      • Type: String
      cloudId
      • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

      • Type: String

 Click for additional details on non-container services
serviceParamSpecs
  • Description: Identifies the specifications for service parameters
    Type: Array of mapped attributes

    paramName
    • Description: Identifies the name for this parameter.
    • Type: String
    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    helpText
    • Description: The additional information provided for this parameter.
    • Type: String
    type
    • Description: The type of parameter used for this specification. See the Parameter Type section for the relevant release for additional details.

    • Type: Enumeration

      API EnumerationCCM UI Listing
      stringstring
      numbernumber
      listlist
      webservicewebservice
      password_input password with confirmation
      passwordpassword
      pathpath
      textarea
      textarea
      secretsecret key (Effective CloudCenter 4.9.0)
    valueList
    • Description: A list of comma separated values (limited to 255 characters). See the Parameter Type section for the relevant release for additional details.
    • Type: String
    webserviceListParams
    • Description: Provide a list of dynamic webservice parameters while deploying a job. From this list, users can select one parameter. The webservice parameter type is available in custom parameters, global parameters, and services. The output should be in the following format:
      [{"name":"p1",
      "displayName":"Param 1"},
       {"name":"p2",
        "displayName":"Param 2"}]

      If you configure this parameter type, you must provide the Protocol (HTTP or HTTPS), Web Service URL, and the credentials (Username and Password) for this webservice.

    • Type: Array of mapped attributes

      url
      • Description: The URL that is associated with the tenant's marketing website. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional details.

        This is not the URL to access the CloudCenter platform

      • Type: String
      protocol
      • Description: Defines the protocol to be used by VMs running this service.
      • Type: Enumeration:

        ProtocolDescription
        TCPTransmission Control Protocol
        UDPUser Datagram Protocol
      username
      • Description: Unique, CloudCenter-generated name reference for this user.
      • Type: String
      password
      • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
      • Type: String
       requestType 
       contentType 
       commandParams 
      • DescriptionIdentifies the query parameters for this call. See the Parameter Type section for the relevant release for additional context.
      • Type: String
       requestBody 
      • Description: Identifies the additional information sent in the request body for each request call.
      • Type: String
       resultString 
      • Type: String

     

    defaultValue
    • Description: The default value for this service parameter
    • Type: String
    userVisible
    • Description: Identifies if a service parameter is visible all users in the tenant
      • true = Parameter is visible to all users
      • false = Parameter is not visible to all users (just the admin)
    • Type: Boolean
    userEditable
    • Description: Identifies if a user is allowed to edit this service parameter:
      • true = Can change the preset values for this parameter
      • false = Cannot change the preset values for this parameter
    • Type: Boolean
    systemParam
    • Description: Identifies if this parameter is provided by the CloudCenter platform:
      • true = Provided by the CloudCenter platform
      • false = Added by the user or derived through another source
    • Type: Boolean
    exampleValue
    • Description: Identifies an example for this service parameter value
    • Type: String
    optional
    • Description: Identifies if this parameter is required for this service:
      • true = This parameter is required for this service
      • false = This parameter is optional for this service
    • Type: Boolean
    valueConstraint
    • Description: Identifies the  value restrictions for parameters created using the CloudCenter platform  
    • Type: Array of mapped attributes

      minValue
      • Description: The minimum required parameter value
      • Type: Integer
      maxValue
      • Description: The maximum allowed parameter value
      • Type: Integer
      regex
      • Description: Identifies if this parameter should be a regular expression
      • Type: String
      allowSpaces
      • Description: Identifies if spaces are allowed in the parameter name:
        • true = Spaces are allowed in the parameter name
        • false = Spaces are not allowed in the parameter name
      • Type: Boolean
      maxLength
      • Description: The maximum allowed length for this parameter name
      • Type: Integer
      sizeValue
      • Description: Identifies the size of this parameter
      • Type: Integer
      step
      • Description: Identifies the step for this parameter in the service execution process
      • Type: Integer
 Click for addtional details on container services

serviceParamSpecs
  • Description: Identifies the specifications for container-based service parameters.
    Type: Array of mapped attributes

    paramName
    • Description: Identifies the name for this parameter.
    • Type: String
    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    helpText
    • Description: The additional information provided for this parameter.
    • Type: String
    type
    • Description: The type of parameter used for this specification. See the Parameter Type section for the relevant release for additional details.

    • Type: Enumeration

      API EnumerationCCM UI Listing
      stringstring
      numbernumber
      listlist
      webservicewebservice
      password_input password with confirmation
      passwordpassword
      pathpath
      textarea
      textarea
      secretsecret key (Effective CloudCenter 4.9.0)

    valueList
    • Description: A list of comma separated values (limited to 255 characters). See the Parameter Type section for the relevant release for additional details.
    • Type: String

    defaultValue
    • Description: The default value for this service parameter
    • Type: String

     confirmValue 
    • Description: In case you provide a password input type parameter, this attribute confirms the password value.
    • Type: String

     pathSuffixValue 
    • Description: The value for the path (text that encodes a URL) type parameter.
    • Type: String

    userVisible
    • Description: Identifies if a service parameter is visible all users in the tenant
      • true = Parameter is visible to all users
      • false = Parameter is not visible to all users (just the admin)
    • Type: Boolean

    userEditable
    • Description: Identifies if a user is allowed to edit this service parameter:
      • true = Can change the preset values for this parameter
      • false = Cannot change the preset values for this parameter
    • Type: Boolean

    systemParam
    • Description: Identifies if this parameter is provided by the CloudCenter platform:
      • true = Provided by the CloudCenter platform
      • false = Added by the user or derived through another source
    • Type: Boolean

    exampleValue
    • Description: Identifies an example for this service parameter value
    • Type: String

    dataUnit
    • Description: Not Used... 
    • Type: String

    optional
    • Description: Identifies if this parameter is required for this service:
      • true = This parameter is required for this service
      • false = This parameter is optional for this service
    • Type: Boolean

    deploymentParam
    • Description: Identifies if this parameter is also used in deployment environments.

    • Type: Boolean

      • true = This attribute is used in deployment environments.

      • false = Default. This attribute is not used in deployment environments.

     multiselectSupported  
    • Description: Identifies if a list for a custom parameter allows the end user to select multiple items in the list.
    • Type: String

    valueConstraint
    • Description: Identifies the  value restrictions for parameters created using the CloudCenter platform  
    • Type: Array of mapped attributes

      minValue
      • Description: The minimum required parameter value
      • Type: Integer
      maxValue
      • Description: The maximum allowed parameter value
      • Type: Integer
      regex
      • Description: Identifies if this parameter should be a regular expression
      • Type: String
      allowSpaces
      • Description: Identifies if spaces are allowed in the parameter name:
        • true = Spaces are allowed in the parameter name
        • false = Spaces are not allowed in the parameter name
      • Type: Boolean
      maxLength
      • Description: The maximum allowed length for this parameter name
      • Type: Integer
      sizeValue
      • Description: Identifies the size of this parameter
      • Type: Integer
      step
      • Description: Identifies the step for this parameter in the service execution process
      • Type: Integer

    scope
    • Description: Indicates the level at which you need to configure this value:

    • Type: Enumeration

      EnumerationDescription
      REGION

      Configure this value at the cloud region level

      USERConfigure this value at the user level


    webserviceListParams
    • Description: Provide a list of dynamic webservice parameters while deploying a job. From this list, users can select one parameter. The webservice parameter type is available in custom parameters, global parameters, and services. The output should be in the following format:
      [{"name":"p1",
      "displayName":"Param 1"},
       {"name":"p2",
        "displayName":"Param 2"}]

      If you configure this parameter type, you must provide the Protocol (HTTP or HTTPS), Web Service URL, and the credentials (Username and Password) for this webservice.

    • Type: Array of mapped attributes

      url
      • Description: The URL that is associated with the tenant's marketing website. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional details.

        This is not the URL to access the CloudCenter platform

      • Type: String
      protocol
      • Description: Defines the protocol to be used by VMs running this service.
      • Type: Enumeration:

        ProtocolDescription
        TCPTransmission Control Protocol
        UDPUser Datagram Protocol
      username
      • Description: Unique, CloudCenter-generated name reference for this user.
      • Type: String
      password
      • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
      • Type: String
       requestType 
       contentType 
       commandParams 
      • DescriptionIdentifies the query parameters for this call. See the Parameter Type section for the relevant release for additional context.
      • Type: String
       requestBody 
      • Description: Identifies the additional information sent in the request body for each request call.
      • Type: String
       resultString 
      • Type: String

     

    secret
    • Description: When you select use secret type (effective CloudCenter 4.9.0), you can configure another layer of abstraction when specifying the Key Name (group level coordinate) and the Key Value (the location) to retrieve the actual value of the secret key for the deployment parameter that uses this type.

    • Type: Array of name-value pairs

      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      value
      • Description: Indicates the set value for this property
      • Type: Float

     collectionList 
    •  Description: When you add a Docker container, you can specify the following parameters.
    • Type: Array of ParamCollectionItems

       ParamCollectionItem 
      • Description: Identifies the Docker-specific parameters if adding a Docker service.
      • Type: Sequence of name-value pairs

         collectionType  
        • Description: The type of parameter.
        • Type: Enumeration

          EnumerationDescription
          STRINGAn alpha-numeric value (limited to 255 characters).
          LISTA list of comma separated values (limited to 255 characters).
          PATHA list of the available locations to select.
         collectionName 
        • Description: Identifies the name for this Docker service parameter 
        • Type: String
         collectionDisplayName 
        • Description: A descriptive name for this Docker service parameter.  
        • Type: String
         collectionValue 
        • Description: The value for this Docker service parameter. 
        • Type: String
         collectionDefaultValue 
        • Description: The default value for this Docker service parameter.  
        • Type: String
         collectionHelpText 
        • Description: The additional information provided for this Docker service parameter 
        • Type: String
         collectionSampleText 
        • Description: Identifies an example for this Docker service parameter value 
        • Type: String
        optional
        • Description: Identifies if this parameter is required for this service:
          • true = This parameter is required for this service
          • false = This parameter is optional for this service
        • Type: Boolean

egressRestrictions
  • Description: Identifies the connection restrictions for this service
  • Type: Sequence of egressServiceNames

     egressServiceName 
    • Description: The name of the service to which this service connects.
    • Type: String

 Click for additional details on child services

childServices
  • DescriptionThe services contained within a service category or a group determined by the admin when defining a service. For example, MySql and Oracle services both have the Database category (or group) as its parent. See Topology Modeler Services or Manage Services for additional context.  
  • Type: Array of child services

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    logoPath
    • Type: String
    defaultImageId
    • DescriptionUnique, system-generated identifier for the default image mapped to a service
    • Type: String
    serviceType
    • Description: The types of service buckets provided by the CloudCenter to define a new service. See External Service and Cloud Service for additional context.

    • Type: Enumeration

      EnumerationDescription
      VM_AGENTDefault. Service based on a VM with a Management Agent
       VM_NO_AGENTService based on a VM without a Management Agent
       EXTERNAL External Service
      CONTAINERContainer Service (effective CloudCenter 4.9.0)
    parentServiceId
    • Description: Unique, system-generated identifier for a service category (a service inherits some attributes from its service category when the service is used to model application profiles)
    • Type: String
    parentService
    • Description: The service category or a group determined by the admin when defining a service. For example, MySql and Oracle services both have the Database category (or group) as its parent. See Topology Modeler Services or Manage Services for additional context. 
      • true = This is the parent service ( value should always be true for consumers using only REST APIs)
      • false = This is not the parent service
    • Type: Boolean
    systemService
    externalService
    • Description: Identifies if this service is an external Service:
      • true = This is the external service
      • false = This is not the external service
    • Type: Boolean
    visible
    • Description: Identifies if this parameter should be visible to the users within a tenant
      • true = The service is displayed if the request attribute parentService = true
      • false = The service is displayed if the request attribute parentService = false
    • Type: Boolean
     externalBundleLocation
    • Description: Location of the zip file that contains the external Bundle Store artifacts that are downloaded during deployment orchestration. 
      • The External Actions Bundle zip file contains all scripts required to manage the external lifecycle. You must provide the following information for this zip file depending on the resource being configured:

        • If you are configuring this file at the cloud region level – this file must contain a directory called cloudregion which contains all the scripts.

        • If you are configuring this file for a service – name this file as ServiceID.zip. For example, tomcat6.zip, where tomcat6 is the Service ID.

      • This attribute is available for all service types
      • The bundle is validated against associated repositories.
      • The repositories field should not be empty.
      • The Service Lifecycle Actions definition (if it is a SCRIPT) is used to locate the scripts in this ZIP file.
      • See Manage Services and the "Parameters and Macros" sections for the relevant release or additional context.
    • Type: String
    bundleLocation
    • Description: Location of the zip file that contains the Bundle Store artifacts that are downloaded during deployment orchestration.

      • Its value is a HTTP(S) URL.

      • The contents of this ZIP file is used to locate the Service Lifecycle Actions definition if it is a SCRIPT.

      • See Manage Services and Parameters and Macros for additional context.

    • Type: String

    costPerHour
    • Description:  The dollar price per hour to use this service. Only the user who created this service (service owner) can set this value (once) for all users using this service.
    • Type: Float
     ownerUserId 
    • DescriptionUnique, system-generated identifier for the owner of the resource. For example, a ServiceNow extension owner's User ID.

    • Type: String

    serviceActions (click for additional details)
    servicePorts
    • Description: Defines the TCP/IP transport layer protocol used in this inbound firewall rule (or security rule)
    • Type: Array of firewallRules

      firewallRule
      • Description: Identifies firewall rules based on your application topology to allow inter-communication between nodes
      • Type: Array of mapped attributes

        protocol
        • Description: Defines the protocol to be used by VMs running this service.
        • Type: Enumeration:

          ProtocolDescription
          TCPTransmission Control Protocol
          UDPUser Datagram Protocol
         fromPort 
        • Description: The initial port number of the port range to use for this inbound firewall rule (or security rule)
        • Type: String
        toPort 
        • Description: The final port number of the port range to use for this inbound firewall rule (or security rule)
        • Type: String
        cloudId
        • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

        • Type: String
    serviceParamSpecs
    • Description: Identifies the specifications for service parameters
      Type: Array of mapped attributes

      paramName
      • Description: Identifies the name for this parameter.
      • Type: String
      displayName
      • DescriptionA descriptive name for this CloudCenter resource.
      • Type: String
      helpText
      • Description: The additional information provided for this parameter.
      • Type: String
      type
      • Description: The type of parameter used for this specification. See the Parameter Type section for the relevant release for additional details.

      • Type: Enumeration

        API EnumerationCCM UI Listing
        stringstring
        numbernumber
        listlist
        webservicewebservice
        password_input password with confirmation
        passwordpassword
        pathpath
        textarea
        textarea
        secretsecret key (Effective CloudCenter 4.9.0)
      valueList
      • Description: A list of comma separated values (limited to 255 characters). See the Parameter Type section for the relevant release for additional details.
      • Type: String
      webserviceListParams
      • Description: Provide a list of dynamic webservice parameters while deploying a job. From this list, users can select one parameter. The webservice parameter type is available in custom parameters, global parameters, and services. The output should be in the following format:
        [{"name":"p1",
        "displayName":"Param 1"},
         {"name":"p2",
          "displayName":"Param 2"}]

        If you configure this parameter type, you must provide the Protocol (HTTP or HTTPS), Web Service URL, and the credentials (Username and Password) for this webservice.

      • Type: Array of mapped attributes

        url
        • Description: The URL that is associated with the tenant's marketing website. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional details.

          This is not the URL to access the CloudCenter platform

        • Type: String
        protocol
        • Description: Defines the protocol to be used by VMs running this service.
        • Type: Enumeration:

          ProtocolDescription
          TCPTransmission Control Protocol
          UDPUser Datagram Protocol
        username
        • Description: Unique, CloudCenter-generated name reference for this user.
        • Type: String
        password
        • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
        • Type: String
         requestType 
         contentType 
         commandParams 
        • DescriptionIdentifies the query parameters for this call. See the Parameter Type section for the relevant release for additional context.
        • Type: String
         requestBody 
        • Description: Identifies the additional information sent in the request body for each request call.
        • Type: String
         resultString 
        • Type: String

       

      defaultValue
      • Description: The default value for this service parameter
      • Type: String
      userVisible
      • Description: Identifies if a service parameter is visible all users in the tenant
        • true = Parameter is visible to all users
        • false = Parameter is not visible to all users (just the admin)
      • Type: Boolean
      userEditable
      • Description: Identifies if a user is allowed to edit this service parameter:
        • true = Can change the preset values for this parameter
        • false = Cannot change the preset values for this parameter
      • Type: Boolean
      systemParam
      • Description: Identifies if this parameter is provided by the CloudCenter platform:
        • true = Provided by the CloudCenter platform
        • false = Added by the user or derived through another source
      • Type: Boolean
      exampleValue
      • Description: Identifies an example for this service parameter value
      • Type: String
      optional
      • Description: Identifies if this parameter is required for this service:
        • true = This parameter is required for this service
        • false = This parameter is optional for this service
      • Type: Boolean
      valueConstraint
      • Description: Identifies the  value restrictions for parameters created using the CloudCenter platform  
      • Type: Array of mapped attributes

        minValue
        • Description: The minimum required parameter value
        • Type: Integer
        maxValue
        • Description: The maximum allowed parameter value
        • Type: Integer
        regex
        • Description: Identifies if this parameter should be a regular expression
        • Type: String
        allowSpaces
        • Description: Identifies if spaces are allowed in the parameter name:
          • true = Spaces are allowed in the parameter name
          • false = Spaces are not allowed in the parameter name
        • Type: Boolean
        maxLength
        • Description: The maximum allowed length for this parameter name
        • Type: Integer
        sizeValue
        • Description: Identifies the size of this parameter
        • Type: Integer
        step
        • Description: Identifies the step for this parameter in the service execution process
        • Type: Integer
    egressRestrictions
    • Description: Identifies the connection restrictions for this service
    • Type: Sequence of egressServiceNames

       egressServiceName 
      • Description: The name of the service to which this service connects.
      • Type: String
    childServices (click for additional details)
    images (click for additional details)
    repositories (click for additional details)

     

 Click for additional details on images

images
  • Description: Identifies details about each image
  • Type: Array of images

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    internalImageName
    • Description: The internal name for this image 
    • Type: String
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    visibility
    • Description: Indicates the type of user to which this image is visible
    • Type: Enumeration

      EnumerationDescription
      PRIVATEThis image is visible only to the tenant owner admin
      PUBLICThis image is visible to all tenants and users.
      PUBLISHEDThis image is visible only to tenant users.
    imageType
    • Description: Identifies whether this image is for the CCO or the application VM
    • Type: Enumeration

      EnumerationDescription
      CLOUD_GATEWAYThe CCO image
      CLOUD_WORKERThe application VM image
    osName
    • Description: Type of operating system associated with this resource
    • Type: Enumeration

      EnumerationDescription
      LINUXThe associated resource is specific to the Linux operating system.
      WINDOWSThe associated resource is specific to the Windows operating system.
    tags
    • DescriptionTags associated with this resource. Each string represents a system tag. See the System Tags section for the relevant release for additional context.

      If you filter reports based on tags that you applied to VMs or jobs, then the report displays all the VMs or jobs that have this exact combination of tags.

    • Type: Array of strings

    enabled
    • Description: Indicates that this resource has been enabled. The default differs based on the resource.

      • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

      • false = The resource has not been enabled.

    • Type: Boolean

    systemImage
    • Description: Indicates whether this image is a predefined system image (see Manage Images for additional context):
      • true =  A predefined system image
      • false = Not a predefined system image
    • Type: Boolean 

    detail (click for more details)

    If the request URL does not have a detail query parameter with the value=true, then this field displays null.

    count
    • Description: The number of times that this phase bundle was added/attached.

      On successful image creation, this value will always remain 0.

    • TypeInteger

     

 Click for additional details on repositories

repositories
  • Description: Identifies attributes for stores and repositories. See Artifact Repository and Share Artifact Repositories for additional context
  • Type: Array of mapped attribute

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)
    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    hostName
    • Description: The DNS host name for this VM.

    • Type: String
    protocol
    • Description: Defines the protocol to be used by VMs running this service.
    • Type: Enumeration:

      ProtocolDescription
      TCPTransmission Control Protocol
      UDPUser Datagram Protocol
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    port
    • Description: Identifies the port used by the Artifact Repository server or the Container.
    • Type: Integer

containerImages
  • Description: Identifies a list of container images with only one of them having a default = true setting.

  • Type: Sequence of URL defaults

    url
    • Description: The Docker registry location for this image.

    • Type: String

    default
    • Description: Identifies that the listed container URL is the default.

    • Type: Boolean

      • true = This URL is the default.

      • false = Default. This URL is not the default.

containerPorts
  • Description: Identifies a list of container images with only one of them having a default = true setting.

  • Type: Sequence of port defaults

    protocol
    • Description: Defines the protocol to be used by VMs running this service.
    • Type: Enumeration:

      ProtocolDescription
      TCPTransmission Control Protocol
      UDPUser Datagram Protocol

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    port
    • Description: Identifies the port used by the Artifact Repository server or the Container.
    • Type: Integer

© 2017-2019 Cisco Systems, Inc. All rights reserved