Add Product Node

Add Product Node

Deploy an additional product node.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/environment/{environmentId}/product/{productId}/node
COPY
Path Parameters
string
environmentId
Required

ID of the environment

string
productId
Required

ID of the product within the environment

Query Parameters
boolean
disableRollback
Optional

Disable rollback in case of failure

Request Body
ProductNodeSpecV2 of type(s) application/json
Required

Show optional properties

{
    "hostName": "string",
    "vmName": "string",
    "rootPassword": "string"
}
{
    "properties": {
        "properties": {}
    },
    "nodeId": 0,
    "isPrimary": false,
    "cpuNum": 0,
    "ramMemory": 0,
    "hostName": "string",
    "vmName": "string",
    "deploymentOption": "string",
    "datastoreName": "string",
    "clusterName": "string",
    "resourcePool": "string",
    "datacenterName": "string",
    "rootPassword": "string",
    "gateway": "string",
    "deployment": {
        "vcenterName": "string",
        "datacenterName": "string",
        "clusterName": "string",
        "resourcePool": "string",
        "vmFolder": "string",
        "datastoreNames": [
            "string"
        ]
    },
    "nics": [
        {
            "ipAddress": "string",
            "networkName": "string",
            "staticRoutes": [
                "string"
            ],
            "dcVcenterNetworksSpec": {
                "portGroupName": "string",
                "gateway": "string",
                "subnetMask": "string",
                "domainName": "string",
                "searchPath": [
                    "string"
                ],
                "useDhcp": false,
                "dns": [
                    "string"
                ],
                "ntp": [
                    "string"
                ]
            }
        }
    ],
    "status": "string"
}
object
properties
Optional

Additional properties

integer As int32 As int32
nodeId
Optional

The ID of the node.

boolean
isPrimary
Optional

Marks node as primary.

integer As int32 As int32
cpuNum
Optional

Number of CPUs to configure the VM with.

integer As int32 As int32
ramMemory
Optional

Memory size (in MB) to configure the VM with.

string As ^([a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-zA-Z0-9])?\.)*[a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-z_A-Z0-9])?$
hostName
Required

Hostname of the node.

string As ^[a-zA-Z0-9][a-zA-Z0-9\-_.()\[\]{}]{0,79}$
vmName
Required

VM name of the node.

string
deploymentOption
Optional

Deployment option of the VM (values depend on the product's OVF properties).

string
datastoreName
Optional

Datastore to use for the VM. If not defined, the first datastore of specified deployment infrastructure vCenter will be used.

string
clusterName
Optional

vCenter cluster name to use for the VM. If not defined, the cluster defined for specified deployment infrastructure vCenter will be used.

string
resourcePool
Optional

vCenter resource pool name to use for the VM. If not defined, the resource pool defined for specified deployment infrastructure vCenter will be used.

string
datacenterName
Optional

Datacenter name to use for the VM. If not defined, the datacenter defined for specified deployment infrastructure vCenter will be used.

string As (^[^'"]{2,32}$)|(^ref:password:[a-zA-Z0-9]{20}$)
rootPassword
Required

The password for root user (or similar admin user depending on OS).

string As ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
gateway
Optional

The gateway to configure for the VM. If not set, the value of the first NIC's network will be used.

DeploymentDetails
deployment
Optional

The target vCenter to deploy the node - to be defined either on product or node level.

array of NicSpecV2
nics
Optional

List of NICs to configure for the VM.

string
status
Optional

status

Possible values are : MAINTENANCE, OFF, SERVICE_OFF, UNKNOWN, OK,
Responses
200

Task ID for the task that adds a new product node.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


400

Invalid product node spec

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


404

Environment or product doesn't exist

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


405

The number of deployed nodes reached the allowed maximum

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


On This Page
Product Operations
POST
Add Integration
POST
Add Product Node
PUT
Configure Certificate
DELETE
Delete Product
DELETE
Delete Product Node
POST
Discover Product
GET
Get All Product Nodes
GET
Get Certificate 1
GET
Get Product Node Spec By Id
PUT
Redeploy Product Node
DELETE
Remove Integration
PATCH
Update All Product Nodes
PUT
Update Integration
PATCH
Update Product Node
PUT
Upgrade Product