CliQr is now part of Cisco Learn More About Cisco

services-get

 

Command Structure

rerun cliqr: services-get --service-id service-id --service-name service-name

Command Description

Retrieves a list of available services or just the services specified by the Service ID or Service Name.

Options

Option

Required?

Default

Description

service-id

No

None

The Service ID of the image.

service-name

No

None

The Service Name of the image.

Guidelines

If you do not specify any option, this command returns all available services and corresponding details.

CloudCenter Release

Introduced in CloudCenter 3.2.6.5

Sample Command and Response

$ rerun cliqr: services-get --service-id 13

{ 
"id": "13",
"resource": "https://<HOST>:<PORT>/api/v1/services/13",
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "tomcat7",
"displayName": "Tomcat7",
"description": "Implementation of the Java Servlet v7",
"logoPath": "/assets/img/tiers/tomcat7.png",
"parentServiceId": 37,
"isAGroup": false,
"isSystemService": true,
"isExternal": false,
"isVisible": true,
"isBundleRequired": true,
"bundleLocation": null,
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [
{
"actionName": "CLEANUP",
"actionType": "SCRIPT",
"exec": "service cleanup"
},
{
"actionName": "INSTALL",
"actionType": "SCRIPT",
"exec": "service install"
},
{
"actionName": "CONFIGURE",
"actionType": "SCRIPT",
"exec": "service configure"
},
{
"actionName": "UPGRADE",
"actionType": "SCRIPT",
"exec": "service upgrade"
},
{
"actionName": "RESTART",
"actionType": "SCRIPT",
"exec": "service restart"
},
{
"actionName": "RELOAD",
"actionType": "SCRIPT",
"exec": "service reload"
},
{
"actionName": "DEPLOY",
"actionType": "SCRIPT",
"exec": "service deploy"
},
{
"actionName": "STOP",
"actionType": "SCRIPT",
"exec": "service stop"
},
{
"actionName": "START",
"actionType": "SCRIPT",
"exec": "service start"
}
],
"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 CliQr 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": [
{
"imageId": "2",
"imageName": "Ubuntu 12.04",
"internalImageName": "CloudWorker-Ubuntu12.04",
"osName": "Linux",
"owner": "2",
"visibility": "PUBLIC"
}
]
}

$ rerun cliqr: services-get --service-name CustomService  

{ 
"id": "48",
"resource": "https://<HOST>:<PORT>/api/v1/services/name/CustomService",
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "CustomService",
"displayName": "Custom Service",
"description": "Custom service",
"logoPath": "/assets/img/tiers/CustomService.png",
"parentServiceId": 0,
"isAGroup": true,
"isSystemService": true,
"isExternal": false,
"isVisible": true,
"isBundleRequired": false,
"bundleLocation": null,
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [],
"serviceParamSpecs": [
{
"paramName": "cliqrNoOfVolumes",
"displayName": "Number of Volumes",
"helpText": "Number of persistent data storage volumes for Custom Service.",
"type": "number",
"valueList": null,
"defaultValue": "0",
"userVisible": true,
"userEditable": true,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": true,
"valueConstraint": {
"minValue": 0,
"maxValue": 65536,
"regex": null,
"allowSpaces": false,
"maxLength": 0,
"sizeValue": 5,
"step": 1
},
"collectionList": []
},
{
"paramName": "cliqrDBDataStorageSize",
"displayName": "Default Volume Size",
"helpText": "Persistent data storage for Custom Service.",
"type": "number",
"valueList": null,
"defaultValue": "",
"userVisible": true,
"userEditable": true,
"systemParam": true,
"exampleValue": null,
"dataUnit": "GB",
"optional": true,
"valueConstraint": {
"minValue": 0,
"maxValue": 65536,
"regex": null,
"allowSpaces": false,
"maxLength": 0,
"sizeValue": 5,
"step": 5
},
"collectionList": []
}
],
"egressRestrictions": [],
"childServices": [
{
"id": "52",
"resource": null,
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "CliqrDeployment",
"displayName": "CliQr Deployment",
"description": "Utilize an existing deployment",
"logoPath": "/assets/img/tiers/CliqrDeployment.png",
"parentServiceId": 48,
"isAGroup": false,
"isSystemService": true,
"isExternal": false,
"isVisible": false,
"isBundleRequired": false,
"bundleLocation": "",
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [],
"serviceParamSpecs": [
{
"paramName": "baseApp",
"displayName": "Application",
"helpText": "Select application to be utilized",
"type": "list",
"valueList": "",
"defaultValue": "",
"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": []
}
],
"egressRestrictions": [],
"childServices": [],
"images": []
},
{
"id": "49",
"resource": null,
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "custom",
"displayName": "Custom",
"description": "Custom Image to run the application",
"logoPath": "/assets/img/tiers/custom.png",
"parentServiceId": 48,
"isAGroup": false,
"isSystemService": true,
"isExternal": false,
"isVisible": false,
"isBundleRequired": false,
"bundleLocation": null,
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [],
"serviceParamSpecs": [
{
"paramName": "minClusterSize",
"displayName": "Minimum number of nodes",
"helpText": null,
"type": "number",
"valueList": null,
"defaultValue": "1",
"userVisible": true,
"userEditable": true,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": {
"minValue": 1,
"maxValue": 1000,
"regex": null,
"allowSpaces": false,
"maxLength": 0,
"sizeValue": 0,
"step": 0
},
"collectionList": []
},
{
"paramName": "maxClusterSize",
"displayName": "Maximum number of nodes",
"helpText": null,
"type": "number",
"valueList": null,
"defaultValue": "2",
"userVisible": true,
"userEditable": true,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": {
"minValue": 1,
"maxValue": 1000,
"regex": null,
"allowSpaces": false,
"maxLength": 0,
"sizeValue": 0,
"step": 0
},
"collectionList": []
},
{
"paramName": "defaultService",
"displayName": null,
"helpText": null,
"type": null,
"valueList": null,
"defaultValue": "custom",
"userVisible": false,
"userEditable": false,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": null,
"collectionList": []
}
],
"egressRestrictions": [],
"childServices": [],
"images": []
},
{
"id": "55",
"resource": null,
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "docker",
"displayName": "Docker",
"description": "Docker container service",
"logoPath": "/assets/img/tiers/docker.png",
"parentServiceId": 48,
"isAGroup": false,
"isSystemService": true,
"isExternal": false,
"isVisible": true,
"isBundleRequired": true,
"bundleLocation": null,
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [
{
"actionName": "STOP",
"actionType": "SCRIPT",
"exec": "service stop"
},
{
"actionName": "INSTALL",
"actionType": "SCRIPT",
"exec": "service install"
},
{
"actionName": "RELOAD",
"actionType": "SCRIPT",
"exec": "service reload"
},
{
"actionName": "START",
"actionType": "SCRIPT",
"exec": "service start"
},
{
"actionName": "RESTART",
"actionType": "SCRIPT",
"exec": "service restart"
},
{
"actionName": "CLEANUP",
"actionType": "SCRIPT",
"exec": "service cleanup"
},
{
"actionName": "UPGRADE",
"actionType": "SCRIPT",
"exec": "service upgrade"
}
],
"serviceParamSpecs": [
{
"paramName": "dockerContainer",
"displayName": "Docker Container",
"helpText": "",
"type": "collection",
"valueList": null,
"defaultValue": "",
"userVisible": true,
"userEditable": true,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": {
"minValue": 0,
"maxValue": 0,
"regex": null,
"allowSpaces": false,
"maxLength": 0,
"sizeValue": 0,
"step": 0
},
"collectionList": [
{
"collectionType": "string",
"collectionName": "containerName",
"collectionDisplayName": "Container Profile",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Unique name for Docker container",
"collectionSampleText": "Docker Container Name",
"optional": false,
"unique": true
},
{
"collectionType": "path",
"collectionName": "dockerImage",
"collectionDisplayName": "Docker Image",
"collectionValue": "{\"Docker Repo\":{\"Docker Hub\":\"%dockerHub%\",\"helpText\":\"Please input Docker Image Name\"},\"Github\":{\"https://\":\"%github_https%\",\"git://\":\"%github_git%\",\"helpText\":\"Please input Github url of the Docker Image Project\"}}",
"collectionDefaultValue": "{\"Repositories\":{\"helpText\":\"Please Input Docker Image Zip file path in %rootPath%\"},\"Storage\":{\"helpText\":\"Please Input Docker Image Zip file path in %rootPath%\"},\"Other Input\":{\"helpText\":\"Please specify the full url of Docker Image Zip file\"}}",
"collectionHelpText": "Select Docker image from Docker hub, Github, Repo or Storage",
"collectionSampleText": "",
"optional": false,
"unique": false
},
{
"collectionType": "string",
"collectionName": "portMap",
"collectionDisplayName": "Port Mapping",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Hostport:DockerPort mappings seperated by comma",
"collectionSampleText": "80:80, 90:8080",
"optional": true,
"unique": false
},
{
"collectionType": "string",
"collectionName": "dockerParam",
"collectionDisplayName": "Docker Parameters",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Additional Docker command parameters",
"collectionSampleText": "-e DB_PORT=3306 -e DB_HOST=\"my.company.com\"",
"optional": true,
"unique": false
},
{
"collectionType": "string",
"collectionName": "progParam",
"collectionDisplayName": "Additional Commands",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Commands for applications to be run in Docker",
"collectionSampleText": "/bin/bash",
"optional": true,
"unique": false
},
{
"collectionType": "string",
"collectionName": "ipAddress",
"collectionDisplayName": "IP Address",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Static IP address to be assigned to this container. Note: Open TCP//UDP for containers to communicate across VMs",
"collectionSampleText": "192.168.0.1",
"optional": true,
"unique": true
},
{
"collectionType": "string",
"collectionName": "linkedContainers",
"collectionDisplayName": "Linked Containers",
"collectionValue": "",
"collectionDefaultValue": "",
"collectionHelpText": "Container name:Alias name separated by comma",
"collectionSampleText": "mysql:db, redis:db2",
"optional": true,
"unique": false
}
]
}
],
"egressRestrictions": [],
"childServices": [],
"images": [
{
"imageId": "20",
"imageName": "Ubuntu 14.04",
"internalImageName": "CloudWorker-Ubuntu14.04",
"osName": "Linux",
"owner": "2",
"visibility": "PUBLIC"
}
]
},
{
"id": "53",
"resource": null,
"perms": [
"write",
"delete",
"read",
"administration"
],
"name": "customagentless",
"displayName": "Custom (Agentless)",
"description": "Custom Image without bootstraping CliQr Tools",
"logoPath": "/assets/img/tiers/custom.png",
"parentServiceId": 48,
"isAGroup": false,
"isSystemService": true,
"isExternal": false,
"isVisible": false,
"isBundleRequired": false,
"bundleLocation": null,
"costPerHour": 0,
"owner": null,
"internalImageName": null,
"serviceBasePackage": null,
"serviceExecutorPackage": null,
"serviceExecutionProfile": null,
"serviceActions": [],
"serviceParamSpecs": [
{
"paramName": "defaultService",
"displayName": null,
"helpText": null,
"type": null,
"valueList": null,
"defaultValue": "custom",
"userVisible": false,
"userEditable": false,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": null,
"collectionList": []
},
{
"paramName": "agentlessBootstrap",
"displayName": null,
"helpText": null,
"type": null,
"valueList": null,
"defaultValue": "true",
"userVisible": false,
"userEditable": false,
"systemParam": true,
"exampleValue": null,
"dataUnit": null,
"optional": false,
"valueConstraint": null,
"collectionList": []
}
],
"egressRestrictions": [],
"childServices": [],
"images": []
}
],
"images": []
}
  • No labels