test text
Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
- Appendix A: API return examples
- Export an application design example
- Import an application design example
- List the candidate topologies that can fulfill the specified partial topology example
- List a container example
- List existing topology design containers example
- List a service design container example
- List containers matching a filter on tag and type example
- List topology design containers matching a filter on tag and type example
- List packages example
- Get package properties example
- List candidate designs example
Import an application design example
Imports an application design by providing the application design in JSON format as input. If the design already exists, as error is returned.
The following URL was sent:
https://localhost:8444/csa/api/codar/app-design/import
The following JSON was sent:
{
"@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
"groupId" : "com.hp.csa",
"artifactId" : "3eb835ae-750f-41c9-8861-de70a285ca43",
"version" : "1.0.0",
"displayName" : "Test_Design-2",
"description" : "my design 02",
"resources" : [ {
"id" : "VcenterServer0001",
"name" : "vCenter Server 1",
"component" : {
"@self" : "/csa/api/topology-model/component-type/b83f4e21-d8a9-4ff3-a76e-3a69775d1d86"
},
"properties" : [ {
"propertyKey" : "requestedMemorySize",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmTemplateReference",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "cpuCount",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddressList",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "closeSession",
"propertyValue" : {
"value" : "true",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "privateKey",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "memorySize",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "requestedCpuCount",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "customizationSpec",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "hostname",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "macAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "password",
"propertyValue" : {
"value" : "null",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "response",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "username",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmID",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmNamePrefix",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
} ],
"outgoingRelations" : [ ],
"annotations" : {
"description" : "",
"displayName" : "vCenter Server 1",
"y" : "-400",
"x" : "-400"
}
}, {
"id" : "VcenterNetworkInterface0001",
"name" : "vCenter Network Interface 1",
"component" : {
"@self" : "/csa/api/topology-model/component-type/05c69cad-ad1d-4285-befe-4963c7f86ae1"
},
"properties" : [ {
"propertyKey" : "response",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "networkInterfaceType",
"propertyValue" : {
"value" : "E1000",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "networkInterfaceId",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "portGroupName",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmID",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "macAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddresses",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
} ],
"outgoingRelations" : [ {
"relationType" : "association",
"id" : "rel0001",
"properties" : [ {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_relation_type",
"propertyValue" : {
"value" : {
"first" : "Association",
"second" : "ASSOCIATION"
},
"type" : "pair",
"confidential" : false,
"consumerVisible" : true
}
} ],
"relationDescriptorName" : "VcenterNetworkInterfaceTypeToVcenterServerType",
"resourceReference" : {
"name" : "vCenter Server 1"
}
} ],
"annotations" : {
"description" : "",
"displayName" : "vCenter Network Interface 1",
"y" : "-400",
"x" : "-200"
}
} ],
"revision" : 0,
"properties" : [ {
"propertyKey" : "metamodelId",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "is_express",
"propertyValue" : {
"value" : null,
"type" : "boolean",
"confidential" : false,
"consumerVisible" : true
}
} ],
"tagIds" : [ ],
"state" : "UNLOCKED",
"profiles" : [ ],
}
The following JSON was returned:
{
"@self" : "/csa/api/topology-model/topology/e57673db-0ee7-4061-8f9e-ffdcabc07b4c",
"@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
"groupId" : "com.hp.csa",
"artifactId" : "3eb835ae-750f-41c9-8861-de70a285ca40",
"version" : "1.0.0",
"displayName" : "Test_Design-1",
"description" : "my design",
"resources" : [ {
"id" : "VcenterServer0001",
"name" : "vCenter Server 1",
"component" : {
"@self" : "/csa/api/topology-model/component-type/b83f4e21-d8a9-4ff3-a76e-3a69775d1d86"
},
"properties" : [ {
"propertyKey" : "requestedMemorySize",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmTemplateReference",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "cpuCount",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddressList",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "closeSession",
"propertyValue" : {
"value" : "true",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "privateKey",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "memorySize",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "requestedCpuCount",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "customizationSpec",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "hostname",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "macAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "password",
"propertyValue" : {
"value" : "null",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "response",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "username",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmID",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmNamePrefix",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
} ],
"outgoingRelations" : [ ],
"annotations" : {
"description" : "",
"displayName" : "vCenter Server 1",
"y" : "-400",
"x" : "-400"
}
}, {
"id" : "VcenterNetworkInterface0001",
"name" : "vCenter Network Interface 1",
"component" : {
"@self" : "/csa/api/topology-model/component-type/05c69cad-ad1d-4285-befe-4963c7f86ae1"
},
"properties" : [ {
"propertyKey" : "response",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "networkInterfaceType",
"propertyValue" : {
"value" : "E1000",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "networkInterfaceId",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "portGroupName",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "vmID",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "macAddress",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "ipAddresses",
"propertyValue" : {
"value" : null,
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
} ],
"outgoingRelations" : [ {
"relationType" : "association",
"id" : "rel0001",
"properties" : [ {
"propertyKey" : "_modifiable_properties",
"propertyValue" : {
"value" : "",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "_relation_type",
"propertyValue" : {
"value" : {
"first" : "Association",
"second" : "ASSOCIATION"
},
"type" : "pair",
"confidential" : false,
"consumerVisible" : true
}
} ],
"relationDescriptorName" : "VcenterNetworkInterfaceTypeToVcenterServerType",
"resourceReference" : {
"name" : "vCenter Server 1"
}
} ],
"annotations" : {
"description" : "",
"displayName" : "vCenter Network Interface 1",
"y" : "-400",
"x" : "-200"
}
} ],
"revision" : 0,
"properties" : [ {
"propertyKey" : "metamodelId",
"propertyValue" : {
"value" : "test",
"type" : "string",
"confidential" : false,
"consumerVisible" : true
}
}, {
"propertyKey" : "is_express",
"propertyValue" : {
"value" : null,
"type" : "boolean",
"confidential" : false,
"consumerVisible" : true
}
} ],
"tagIds" : [ ],
"state" : "UNLOCKED",
"profiles" : [ ],
"annotations" : {
"providerType" : "independent",
"serviceBlueprintId" : "8a818cf045d640b00145d64a7c240017"
}
}
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to clouddocs@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: